GitHub PR Manager

概述

通过 gh CLI 流程化管理 GitHub Pull Request 生命周期：创建、评审、合并、生成变更日志、检查 CI 状态以及草稿管理。适用于 Codex 需要管理 PR 全流程、检查评审状态、处理合并冲突或生成变更日志的场景。

快速开始

前置条件

• 已安装并认证 gh CLI（可通过 gh auth status 检查）
• 本地 Git 仓库已关联 GitHub 远程仓库

查看个人 PR 摘要

bash scripts/gh-pr-review.sh --mine

使用自动生成内容创建 PR

python3 scripts/gh-pr-create.py --draft --label review-needed

从已合并的 PR 生成变更日志

python3 scripts/gh-pr-changelog.py --from v1.0 --to v2.0

常用操作

创建与管理 PR

# 创建草稿 PR
gh pr create --draft --title "WIP: Add login" --body "In progress"

# 创建带标签的 PR
gh pr create --label enhancement --label needs-review

# 查看 PR 详情
gh pr view <number>         # 在终端中查看
gh pr view <number> --web   # 在浏览器中打开

# 更新 PR
gh pr edit <number> --title "New title" --add-label ready

评审流程

# 查看需要我评审的 PR
gh pr list --search "review-required:@me" --state open

# 批准
gh pr review <number> --approve --body "LGTM"

# 要求修改
gh pr review <number> --request-changes --body "Please fix the tests"

# 添加评论
gh pr review <number> --comment --body "Nice work!"

# 检查 PR 的评审状态
gh pr view <number> --json reviewDecision,reviews

CI 与合并

# 检查 CI 状态
gh pr checks <number>            # 详细状态信息
gh pr view <number> --json statusCheckRollup

# 在 CI 通过后合并
gh pr merge <number> --squash    # 压缩合并
gh pr merge <number> --rebase    # 变基合并
gh pr merge <number> --merge     # 合并提交
gh pr merge <number> --auto      # CI 通过后自动合并

# 检查是否可合并
gh pr view <number> --json mergeable,mergeStateStatus

冲突解决

# 检查 PR 是否存在合并冲突
gh pr view 42 --json mergeable
# → 若存在冲突，返回 "CONFLICTING"

# 本地修复
git checkout <pr-branch>
git fetch origin
git merge origin/main                # 解决冲突
git push

# 替代方案：使用 rebase
git rebase origin/main               # 解决冲突
git push --force-with-lease

分支操作

# 本地检出 PR 用于测试
gh pr checkout <number>

# 列出我的分支及对应 PR 状态
gh pr list --author "@me" --json headRefName,title,state,isDraft

# 对比分支差异
gh pr diff <number>              # 查看差异
gh pr diff <number> --name-only  # 仅显示文件名

参考资料

• **scripts/gh-pr-create.py** —— 根据提交记录自动生成标题和正文的 PR 创建脚本
• **scripts/gh-pr-review.sh** —— 查看待评审项及 CI 状态概览
• **scripts/gh-pr-changelog.py** —— 从指定版本间的已合并 PR 生成变更日志
• 参见 references/pr-templates.md 获取 PR 模板示例
• 参见 references/label-conventions.md 了解标签命名规范