GitHub PR 工作流

GitHub PR 生命周期：分支、提交、打开、CI、合并。

技能元数据


来源	内置（默认安装）
路径	`skills/github/github-pr-workflow`
版本	`1.1.0`
作者	Hermes 智能体
许可证	MIT
平台	linux, macos, windows
标签	`GitHub`, `Pull-Requests`, `CI/CD`, `Git`, `自动化`, `合并`
相关技能	`github-auth`, `github-code-review`

信息

以下是当此技能被触发时，Hermes 加载的完整技能定义。这就是智能体在此技能激活时看到的指令。

GitHub 拉取请求工作流程

管理 PR 生命周期的完整指南。每个部分先展示使用 gh 的方法，然后展示用于没有 gh 命令的机器的 git + curl 备用方案。

前提条件

已通过 GitHub 认证（参见 github-auth 技能）
在一个拥有 GitHub 远程仓库的 git 仓库内

快速认证检测

# 确定整个工作流中使用哪种方法
if command -v gh &>/dev/null && gh auth status &>/dev/null; then
  AUTH="gh"
else
  AUTH="git"
  # 确保我们有用于 API 调用的令牌
  if [ -z "$GITHUB_TOKEN" ]; then
    if [ -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 "使用: $AUTH"

从 Git 远程仓库提取 Owner/Repo

许多 curl 命令需要 owner/repo。从 git 远程仓库中提取它：

# 适用于 HTTPS 和 SSH 远程 URL
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 操作——两种方式都一样：

# 确保您是最新的
git fetch origin
git checkout main && git pull origin main

# 创建并切换到一个新分支
git checkout -b feat/add-user-authentication

分支命名约定：

feat/description — 新功能
fix/description — 错误修复
refactor/description — 代码重构
docs/description — 文档
ci/description — CI/CD 变更

2. 进行提交

使用智能体的文件工具（write_file、patch）进行更改，然后提交：

# 暂存特定文件
git add src/auth.py src/models/user.py tests/test_auth.py

# 使用约定式提交信息提交
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): 简短描述

如果需要更长的解释，请换行在 72 个字符处。

类型：feat, fix, refactor, docs, test, ci, chore, perf

3. 推送和创建 PR

推送分支（两种方式相同）

git push -u origin HEAD

创建 PR

使用 gh：

gh pr create \
  --title "feat: add JWT-based user authentication" \
  --body "## 摘要
- 添加登录和注册 API 端点
- JWT 令牌生成和验证

## 测试计划
- [ ] 单元测试通过

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\": \"## 摘要\n添加登录和注册 API 端点。\n\nCloses #42\",
    \"head\": \"$BRANCH\",
    \"base\": \"main\"
  }"

响应 JSON 包含 PR 的 number — 保存它以备后续命令使用。

要创建为草稿，请在 JSON body 中添加 "draft": true。

4. 监控 CI 状态

检查 CI 状态

使用 gh：

# 一次性检查
gh pr checks

# 看到所有检查完成（每 10 秒轮询一次）
gh pr checks --watch

使用 git + curl：

# 获取当前分支上的最新提交 SHA
SHA=$(git rev-parse HEAD)

# 查询组合状态
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\"总体状态: {data['state']}\")
for s in data.get('statuses', []):
    print(f\"  {s['context']}: {s['state']} - {s.get('description', '')}\")"

# 也检查 GitHub Actions 检查运行（单独的端点）
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 '待定'}\")"

轮询直到完成（git + curl）

# 简单的轮询循环 — 每 30 秒检查一次，最多 10 分钟
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 "检查 $i: $STATUS"
  if [ "$STATUS" = "success" ] || [ "$STATUS" = "failure" ] || [ "$STATUS" = "error" ]; then
    break
  fi
  sleep 30
done

5. 自动修复 CI 失败

当 CI 失败时，进行诊断和修复。此循环适用于任一认证方法。

步骤 1：获取失败详情

使用 gh：

# 列出此分支上最近的工作流运行
gh run list --branch $(git branch --show-current) --limit 5

# 查看失败的日志
gh run view <RUN_ID> --log-failed

使用 git + curl：

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

# 列出此分支上的工作流运行
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\"运行 {r['id']}: {r['name']} - {r['conclusion'] or r['status']}\")"

# 获取失败作业的日志（下载为 zip，解压，读取）
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：修复并推送

确定问题后，使用文件工具（patch、write_file）进行修复：

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

步骤 3：验证

使用上面第 4 部分的命令重新检查 CI 状态。

自动修复循环模式

当被要求自动修复 CI 时，请遵循此循环：

检查 CI 状态 → 确定失败项
阅读失败日志 → 理解错误
使用 read_file + patch/write_file → 修复代码
git add . && git commit -m "fix: ..." && git push
等待 CI → 重新检查状态
如果仍然失败则重复（最多 3 次尝试，然后询问用户）

6. 合并

使用 gh：

# 压缩合并并删除分支（对于功能分支最干净）
gh pr merge --squash --delete-branch

# 启用自动合并（当所有检查通过时合并）
gh pr merge --auto --squash --delete-branch

使用 git + curl：

PR_NUMBER=<number>

# 通过 API 合并 PR（压缩）
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)\"
  }"

# 合并后删除远程分支
BRANCH=$(git branch --show-current)
git push origin --delete $BRANCH

# 在本地切换回主分支
git checkout main && git pull origin main
git branch -d $BRANCH

合并方法："merge"（合并提交）、"squash"（压缩）、"rebase"（变基）

启用自动合并（curl）

# 自动合并需要仓库在设置中启用此功能。
# 这使用 GraphQL API，因为 REST 不支持自动合并。
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. 从干净的主分支开始
git checkout main && git pull origin main

# 2. 创建分支
git checkout -b fix/login-redirect-bug

# 3. （智能体使用文件工具进行代码更改）

# 4. 提交
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. 推送
git push -u origin HEAD

# 6. 创建 PR（根据可用性选择 gh 或 curl）
# ... （参见第 3 部分）

# 7. 监控 CI（参见第 4 部分）

# 8. 通过时合并（参见第 6 部分）

有用的 PR 命令参考

操作	gh	git + curl
列出我的 PR	`gh pr list --author @me`	`curl -s -H "Authorization: token $GITHUB_TOKEN" "https://api.github.com/repos/$OWNER/$REPO/pulls?state=open"`
查看 PR 差异	`gh pr diff`	`git 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 user`	`curl -X POST .../pulls/N/requested_reviewers -d '{"reviewers":["user"]}'`
关闭 PR	`gh pr close N`	`curl -X PATCH .../pulls/N -d '{"state":"closed"}'`
检出某人的 PR	`gh pr checkout N`	`git fetch origin pull/N/head:pr-N && git checkout pr-N`

技能元数据​

GitHub 拉取请求工作流程

前提条件​

快速认证检测​

从 Git 远程仓库提取 Owner/Repo​

1. 分支创建​

2. 进行提交​

3. 推送和创建 PR​

推送分支（两种方式相同）​

创建 PR​

4. 监控 CI 状态​

检查 CI 状态​

轮询直到完成（git + curl）​

5. 自动修复 CI 失败​

步骤 1：获取失败详情​

步骤 2：修复并推送​

步骤 3：验证​

自动修复循环模式​

6. 合并​

启用自动合并（curl）​

7. 完整工作流示例​

有用的 PR 命令参考​

技能元数据

前提条件

快速认证检测

从 Git 远程仓库提取 Owner/Repo

1. 分支创建

2. 进行提交

3. 推送和创建 PR

推送分支（两种方式相同）

创建 PR

4. 监控 CI 状态

检查 CI 状态

轮询直到完成（git + curl）

5. 自动修复 CI 失败

步骤 1：获取失败详情

步骤 2：修复并推送

步骤 3：验证

自动修复循环模式

6. 合并

启用自动合并（curl）

7. 完整工作流示例

有用的 PR 命令参考