SuperAPI AI 工具集

pr-review-comments

通用与其它

查看项目

更新于 10-15 21:52

技能介绍

用途:把一份 JSON 数组形式的审查发现发布为 GitHub Pull Request 的行内评论,每条评论锚定到具体文件与行号。通过已认证的 gh CLI 调用 GitHub API,无需自行处理令牌。

前提条件:已安装并认证 gh CLI(gh auth status);需要目标 PR 编号;需要 JSON 文件,为对象数组,每个对象必填 file、line,正文来自 summary 和/或 failure_scenario(合并为 body),或显式提供 body。仓库默认由 gh repo view 自动识别,可用 --repo OWNER/REPO 覆盖。

关键限制:GitHub 只接受目标行属于 PR diff 的行内评论。line 是新文件中的行号(删除行用 side: "LEFT")。脚本会拉取 PR diff,逐条校验发现是否落在实际 hunk 内,跳过 diff 之外的行并在末尾报告,避免静默丢失。无法给未变更、不在 diff 中的行附加行内评论。

工作流:确认 JSON 路径与 PR 编号;先干跑查看将发布与将跳过的内容:scripts/post_pr_comments.py --pr <N> --json <path> --dry-run;核对 Postable/Skipped 计数,若因 diff 变动导致行号过期需先修正;再正式发布,默认 grouped 模式(一次 PR review 打包所有评论):scripts/post_pr_comments.py --pr <N> --json <path> --event COMMENT;或 individual 模式(每条发现单独一条行内评论):scripts/post_pr_comments.py --pr <N> --json <path> --mode individual;最后回报创建的 review/评论 URL 及被跳过的发现列表。

模式选择:grouped(默认)走 POST /pulls/{n}/reviews,适合把一组发现作为一次 review 发布,只产生一次通知,可设 --event APPROVE | REQUEST_CHANGES | COMMENT;individual 走 POST /pulls/{n}/comments,适合增量添加独立评论或每条发现单独成线程/通知。默认用 grouped 加 --event COMMENT。

选项:--pr N(必填)、--json PATH(必填)、--repo OWNER/REPO、--mode grouped|individual(默认 grouped)、--event COMMENT|APPROVE|REQUEST_CHANGES(默认 COMMENT)、--review-body TEXT、--commit SHA(默认 PR head SHA)、--dry-run。多行范围评论可在 JSON 对象中加 start_line(及可选 start_side)。建议在不熟悉的 PR 上先 --dry-run,过期行号是最常见失败原因。脚本是可靠路径,不建议手写 gh api 调用。