SuperAPI AI 工具集

github-pr-workflow

编程与开发

查看项目

更新于 10-16 08:16

技能介绍

用途

GitHub PR Workflow 是一套用于管理 GitHub Pull Request 生命周期的完整指南。它覆盖 PR 从创建到合并的各个环节,并且在每一部分都优先展示 gh 命令行工具的用法,随后提供在无法使用 gh 的机器上通过 git 加 curl 调用 GitHub API 的替代方案。

前置条件

  • 已通过 GitHub 认证(参见 github-auth 技能)。
  • 处于一个带有 GitHub 远程仓库的 git 仓库中。

主要能力

认证方式检测

通过检查 gh 是否存在且已认证,决定后续全程使用 gh 还是 git 加 curl。若无 gh,则尝试从环境变量或 hermes 环境文件中读取 GITHUB_TOKEN,或从 ~/.git-credentials 中提取令牌。

提取 owner/repo

许多 curl 命令需要 owner/repo,可从 git 远程地址中提取,同时兼容 HTTPS 和 SSH 形式的远程 URL。

分支创建

这一部分为纯 git 操作。先拉取并更新 main,再创建并切换到新分支。提供的分支命名约定包括:feat/、fix/、refactor/、docs/、ci/ 等前缀。

提交

使用代理的文件工具(write_file、patch)修改后,暂存指定文件并提交。提交信息采用 Conventional Commits 格式:type(scope): 简短描述,正文按 72 字符换行。类型包括 feat、fix、refactor、docs、test、ci、chore、perf。

推送与创建 PR

推送分支后创建 PR。gh 方式支持 --title、--body、--draft、--reviewer、--label、--base 等选项。curl 方式通过 POST 调用 pulls 接口,响应 JSON 中包含 PR 编号,可保存供后续命令使用;设置 draft 为 true 可创建草稿 PR。

监控 CI 状态

gh 方式可用 gh pr checks 一次性检查,或 gh pr checks --watch 轮询。curl 方式获取当前分支最新提交 SHA,查询 commits/SHA/status 综合状态,并单独查询 check-runs 接口。还提供了每 30 秒轮询、最多 10 分钟的循环脚本。

自动修复 CI 失败

步骤包括:获取失败详情(gh run list、gh run view --log-failed,或 curl 列出分支上的 workflow runs 并下载失败日志 zip 解压查看)、使用文件工具修复、提交推送、再次验证。给出了自动修复循环模式:检查状态到识别失败、读日志、修改代码、提交推送、等待并复查,最多重试 3 次后询问用户。

合并

gh 方式支持 squash 合并并删除分支,或用 --auto 启用自动合并。curl 方式通过 PUT 调用 merge 接口,合并方法可选 merge、squash、rebase;合并后删除远程分支、切回本地 main 拉取并删除本地分支。自动合并因 REST 不支持而使用 GraphQL API,且需仓库在设置中启用。

完整工作流示例与命令参考

提供从 main 开始、建分支、改代码、提交、推送、创建 PR、监控 CI、合并的完整串联示例,并附常用 PR 命令对照表,包括列出我的 PR、查看 PR diff、添加评论、请求评审、关闭 PR、检出他人 PR,每项都给出 gh 与 curl 两种做法。

使用方式

依据当前机器的环境选择 gh 或 git 加 curl 路径,按分支、提交、推送、创建 PR、监控 CI、修复失败、合并的顺序逐段执行相应命令。

适用场景

需要在 GitHub 上完成一次完整的 PR 流程,或者需要在没有 gh 工具的环境中通过 API 完成同样操作时。

限制

自动合并需要仓库在设置中启用。轮询脚本设置了重试次数与等待时间上限。其他具体平台或收费信息暂未提供。