SuperAPI AI 工具集

bonfire-review-pr

编程与开发

查看项目

更新于 10-16 06:10

技能介绍

用途

bonfire-review-pr 用于审查 GitHub Pull Request,并将审查发现以行内评论的形式发布到 PR 上。它适合在需要快速、结构化地检查 PR 盲点、缺口和改进点的场景中使用。

主要能力

  • 解析 PR 编号参数(支持 333 或 #333 形式)。
  • 获取 PR 元数据,包括编号、标题、head 分支、base 分支、head 提交 SHA、URL、描述和变更文件列表。
  • 在隔离的 worktree 中检出 PR 分支,避免影响当前工作区。
  • 获取 PR 相对目标分支的 diff 统计和变更文件列表。
  • 通过 bonfire:work-reviewer 子代理执行审查,返回按严重程度(critical/moderate/minor)分类、带 file:line 引用和修复工作量的发现。
  • 支持用户选择发布全部、部分或不发布评论。
  • 对带行号的发现发布行内评论,对无行号的发现发布普通 PR 评论。
  • 审查完成后可清理 worktree 并输出摘要。

使用方式

调用命令:

/bonfire-review-pr <pr-number>

示例:

/bonfire-review-pr 333

若未提供 PR 编号,会显示用法并中止。

执行流程:

  1. 解析参数,提取 PR 编号。
  2. 获取 PR 元数据:
gh pr view <number> --json number,title,headRefName,baseRefName,headRefOid,url,body,files

若 PR 不存在,则中止并提示 "PR # not found in this repository."。

  1. 计算 worktree 路径:<git-root>/../<repo-name>-pr-<number>-review。
  2. 创建 worktree:
git fetch origin <headRefName>
git worktree add <worktree-path> origin/<headRefName>

若 worktree 已存在,会询问是否移除并重建。

  1. 获取 PR diff:
git -C <worktree-path> diff origin/<baseRefName>...HEAD --stat
git -C <worktree-path> diff origin/<baseRefName>...HEAD --name-only
  1. 调用 bonfire:work-reviewer 子代理执行审查,提供 PR 编号、标题、描述、变更文件列表和 worktree 路径。子代理在隔离上下文(sonnet 模型)中运行。
  2. 展示按严重程度分组的发现。
  3. 询问用户要发布哪些发现(全部/选择/不发布)。
  4. 发布评论。带行号的发现使用:
gh api repos/{owner}/{repo}/pulls/<number>/comments \
  -f body="**Review Finding**\n\n<finding description>\n\n*Severity: <severity> | Effort: <effort>*" \
  -f commit_id="<headRefOid>" \
  -f path="<file-path>" \
  -f line=<line-number>

无行号的发现使用:

gh pr comment <number> --body "**Review Finding**\n\n<finding description>\n\n*Severity: <severity> | Effort: <effort>*"

注意:GitHub 仅允许对 PR diff 中的文件发布行内评论;若发现引用的文件不在 diff 中,则改为普通 PR 评论。

  1. 询问是否移除 worktree,若同意则执行:
git worktree remove <worktree-path>
  1. 输出摘要,包括 PR 编号、标题、发现总数、已发布评论数、PR URL 和 worktree 状态。

适用场景

  • 需要对 GitHub PR 进行结构化审查并自动发布评论。
  • 希望在隔离环境中审查 PR,不影响当前工作区。
  • 需要按严重程度分类并带具体 file:line 引用的审查结果。

限制

  • 依赖 gh CLI 和 git worktree 功能。
  • 行内评论仅支持 PR diff 中的文件。
  • 子代理失败时会回退到基于 diff 的上下文审查。
  • 其他具体限制暂未提供。