Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help


title: “Github Pr Workflow — GitHub PR lifecycle: branch, commit, open, CI, merge” sidebar_label: “Github Pr Workflow” description: “GitHub PR lifecycle: branch, commit, open, CI, merge”

{/* 本页面由 website/scripts/generate-skill-docs.py 根据技能对应的 SKILL.md 文件自动生成。请直接编辑源文件 SKILL.md,而非此页面。 */}

GitHub Pull Request 工作流

GitHub PR 生命周期:分支创建、代码提交、PR 提交、CI 测试、合并代码。

技能元数据

来源内置(默认已安装)
路径skills/github/github-pr-workflow
版本1.1.0
开发者Hermes Agent
许可协议MIT
支持平台linux、macos、windows
标签GitHubPull-RequestsCI/CDGitAutomationMerge
相关技能github-authgithub-code-review

参考:完整 SKILL.md 内容

:::info 以下是当触发该技能时 Hermes 所加载的完整技能定义。技能处于激活状态时,代理程序会将此内容视为操作指令。
::

GitHub Pull Request 工作流

关于管理 PR 生命周期的完整指南。各章节首先介绍使用 gh 命令的方案,随后为未安装 gh 的机器提供 git + curl 的备用方案。

先决条件

  • 已在 GitHub 上完成身份验证(参见 github-auth 技能)
  • 所处环境为拥有 GitHub 远程仓库的 git 项目目录

快速身份验证检测

# Determine which method to use throughout this workflow
if command -v gh &>/dev/null && gh auth status &>/dev/null; then
  AUTH="gh"
else
  AUTH="git"
  # Ensure we have a token for API calls
  if [ -z "$GITHUB_TOKEN" ]; then
    if _hermes_env="${HERMES_HOME:-$HOME/.hermes}/.env"; [ -f "$_hermes_env" ] && grep -q "^GITHUB_TOKEN=" "$_hermes_env"; then
      GITHUB_TOKEN=$(grep "^GITHUB_TOKEN=" "$_hermes_env" | head -1 | cut -d= -f2 | tr -d '\n\r')
    elif grep -q "github.com" ~/.git-credentials 2>/dev/null; then
      GITHUB_TOKEN=$(grep "github.com" ~/.git-credentials 2>/dev/null | head -1 | sed 's|https://[^:]*:\([^@]*\)@.*|\1|')
    fi
  fi
fi
echo "Using: $AUTH"

从 Git 远程地址中提取所有者/仓库名

许多 curl 命令都需要知道 owner/repo 的信息。可直接从 git 远程地址中获取该信息:

# Works for both HTTPS and SSH remote URLs
REMOTE_URL=$(git remote get-url origin)
OWNER_REPO=$(echo "$REMOTE_URL" | sed -E 's|.*github\.com[:/]||; s|\.git$||')
OWNER=$(echo "$OWNER_REPO" | cut -d/ -f1)
REPO=$(echo "$OWNER_REPO" | cut -d/ -f2)
echo "Owner: $OWNER, Repo: $REPO"

1. 分支创建

此步骤完全基于 git 操作——无论采用何种方式结果都一致:

# Make sure you're up to date
git fetch origin
git checkout main && git pull origin main

# Create and switch to a new branch
git checkout -b feat/add-user-authentication

分支命名规范:

  • feat/描述内容 —— 新功能开发
  • fix/描述内容 —— 错误修复
  • refactor/描述内容 —— 代码重构
  • docs/描述内容 —— 文档更新
  • ci/描述内容 —— CI/CD相关更改

2. 提交代码变更

首先使用代理的文件操作工具(write_filepatch)进行修改,之后再提交:

# Stage specific files
git add src/auth.py src/models/user.py tests/test_auth.py

# Commit with a conventional commit message
git commit -m "feat: add JWT-based user authentication

- Add login/register endpoints
- Add User model with password hashing
- Add auth middleware for protected routes
- Add unit tests for auth flow"

提交信息格式(常规提交规范):

type(scope): short description

Longer explanation if needed. Wrap at 72 characters.

类型:featfixrefactordocstestcichoreperf

3. 推送代码并创建 Pull Request

推送分支(两种方式均可)

git push -u origin HEAD

创建 Pull Request

使用 gh 命令:

gh pr create \
  --title "feat: add JWT-based user authentication" \
  --body "## Summary
- Adds login and register API endpoints
- JWT token generation and validation

## Test Plan
- [ ] Unit tests pass

Closes #42"

选项:--draft--reviewer user1,user2--label "enhancement"--base develop

通过 git + curl 使用:

BRANCH=$(git branch --show-current)

curl -s -X POST \
  -H "Authorization: token $GITHUB_TOKEN" \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/repos/$OWNER/$REPO/pulls \
  -d "{
    \"title\": \"feat: add JWT-based user authentication\",
    \"body\": \"## Summary\nAdds login and register API endpoints.\n\nCloses #42\",
    \"head\": \"$BRANCH\",
    \"base\": \"main\"
  }"

响应的 JSON 中包含 PR 的 number 字段——请将其保存下来,以便后续使用。

如需将任务创建为草稿,可在 JSON 正文中添加 "draft": true

4. 监控 CI 状态

检查 CI 状态

使用 gh 时:

# One-shot check
gh pr checks

# Watch until all checks finish (polls every 10s)
gh pr checks --watch

使用 git + curl 方式:

# Get the latest commit SHA on the current branch
SHA=$(git rev-parse HEAD)

# Query the combined status
curl -s \
  -H "Authorization: token $GITHUB_TOKEN" \
  https://api.github.com/repos/$OWNER/$REPO/commits/$SHA/status \
  | python3 -c "
import sys, json
data = json.load(sys.stdin)
print(f\"Overall: {data['state']}\")
for s in data.get('statuses', []):
    print(f\"  {s['context']}: {s['state']} - {s.get('description', '')}\")"

# Also check GitHub Actions check runs (separate endpoint)
curl -s \
  -H "Authorization: token $GITHUB_TOKEN" \
  https://api.github.com/repos/$OWNER/$REPO/commits/$SHA/check-runs \
  | python3 -c "
import sys, json
data = json.load(sys.stdin)
for cr in data.get('check_runs', []):
    print(f\"  {cr['name']}: {cr['status']} / {cr['conclusion'] or 'pending'}\")"

循环轮询直至任务完成(git + curl)

# Simple polling loop — check every 30 seconds, up to 10 minutes
SHA=$(git rev-parse HEAD)
for i in $(seq 1 20); do
  STATUS=$(curl -s \
    -H "Authorization: token $GITHUB_TOKEN" \
    https://api.github.com/repos/$OWNER/$REPO/commits/$SHA/status \
    | python3 -c "import sys,json; print(json.load(sys.stdin)['state'])")
  echo "Check $i: $STATUS"
  if [ "$STATUS" = "success" ] || [ "$STATUS" = "failure" ] || [ "$STATUS" = "error" ]; then
    break
  fi
  sleep 30
done

5. 自动修复 CI 失败问题

当 CI 流水线失败时,系统会自动进行诊断并解决问题。该流程适用于任何认证方式。

第一步:获取失败详情

使用 gh 认证时:

# List recent workflow runs on this branch
gh run list --branch $(git branch --show-current) --limit 5

# View failed logs
gh run view <RUN_ID> --log-failed

使用 git + curl 方式:

BRANCH=$(git branch --show-current)

# List workflow runs on this branch
curl -s \
  -H "Authorization: token $GITHUB_TOKEN" \
  "https://api.github.com/repos/$OWNER/$REPO/actions/runs?branch=$BRANCH&per_page=5" \
  | python3 -c "
import sys, json
runs = json.load(sys.stdin)['workflow_runs']
for r in runs:
    print(f\"Run {r['id']}: {r['name']} - {r['conclusion'] or r['status']}\")"

# Get failed job logs (download as zip, extract, read)
RUN_ID=<run_id>
curl -s -L \
  -H "Authorization: token $GITHUB_TOKEN" \
  https://api.github.com/repos/$OWNER/$REPO/actions/runs/$RUN_ID/logs \
  -o /tmp/ci-logs.zip
cd /tmp && unzip -o ci-logs.zip -d ci-logs && cat ci-logs/*.txt

第 2 步:修复并推送

确定问题后,可使用文件工具(patchwrite_file)对问题进行修复:

git add <fixed_files>
git commit -m "fix: resolve CI failure in <check_name>"
git push

第3步:验证

使用上文第4节中的命令重新检查CI状态。

自动修复循环流程

当被要求自动修复CI问题时,请遵循以下循环步骤:

  1. 检查CI状态 → 确定故障点
  2. 查看故障日志 → 理解错误原因
  3. 使用 read_file + patch/write_file → 修复代码
  4. 执行 git add . && git commit -m "fix: ..." && git push
  5. 等待CI构建完成 → 再次检查状态
  6. 若仍存在故障则重复上述步骤(最多尝试3次,之后需询问用户)

6. 合并代码

使用gh时:

# Squash merge + delete branch (cleanest for feature branches)
gh pr merge --squash --delete-branch

# Enable auto-merge (merges when all checks pass)
gh pr merge --auto --squash --delete-branch

使用 git + curl 方式:

PR_NUMBER=<number>

# Merge the PR via API (squash)
curl -s -X PUT \
  -H "Authorization: token $GITHUB_TOKEN" \
  https://api.github.com/repos/$OWNER/$REPO/pulls/$PR_NUMBER/merge \
  -d "{
    \"merge_method\": \"squash\",
    \"commit_title\": \"feat: add user authentication (#$PR_NUMBER)\"
  }"

# Delete the remote branch after merge
BRANCH=$(git branch --show-current)
git push origin --delete $BRANCH

# Switch back to main locally
git checkout main && git pull origin main
git branch -d $BRANCH

合并方式:"merge"(合并提交)、"squash""rebase"

启用自动合并(curl命令)

# Auto-merge requires the repo to have it enabled in settings.
# This uses the GraphQL API since REST doesn't support auto-merge.
PR_NODE_ID=$(curl -s \
  -H "Authorization: token $GITHUB_TOKEN" \
  https://api.github.com/repos/$OWNER/$REPO/pulls/$PR_NUMBER \
  | python3 -c "import sys,json; print(json.load(sys.stdin)['node_id'])")

curl -s -X POST \
  -H "Authorization: token $GITHUB_TOKEN" \
  https://api.github.com/graphql \
  -d "{\"query\": \"mutation { enablePullRequestAutoMerge(input: {pullRequestId: \\\"$PR_NODE_ID\\\", mergeMethod: SQUASH}) { clientMutationId } }\"}"

7. 完整工作流示例

# 1. Start from clean main
git checkout main && git pull origin main

# 2. Branch
git checkout -b fix/login-redirect-bug

# 3. (Agent makes code changes with file tools)

# 4. Commit
git add src/auth/login.py tests/test_login.py
git commit -m "fix: correct redirect URL after login

Preserves the ?next= parameter instead of always redirecting to /dashboard."

# 5. Push
git push -u origin HEAD

# 6. Create PR (picks gh or curl based on what's available)
# ... (see Section 3)

# 7. Monitor CI (see Section 4)

# 8. Merge when green (see Section 6)

实用的 Pull Request 命令参考

操作ghgit + curl
列出我的 Pull Requestgh pr list --author @mecurl -s -H "Authorization: token $GITHUB_TOKEN" "https://api.github.com/repos/$OWNER/$REPO/pulls?state=open"
查看 PR 差异gh pr diffgit diff main...HEAD(本地操作)或 curl -H "Accept: application/vnd.github.diff" ...
添加评论gh pr comment N --body "..."curl -X POST .../issues/N/comments -d '{"body":"..."}'
请求审核gh pr edit N --add-reviewer usercurl -X POST .../pulls/N/requested_reviewers -d '{"reviewers":["user"]}'
关闭 PRgh pr close Ncurl -X PATCH .../pulls/N -d '{"state":"closed"}'
拉取他人的 PR 代码gh pr checkout Ngit fetch origin pull/N/head:pr-N && git checkout pr-N