SuperAPI AI 工具集

address-pr-comments

编程与开发

查看项目

更新于 10-26 16:19

技能介绍

用途

address-pr-comments 用于自动化处理 GitHub 拉取请求(PR)上的评审评论。当用户希望回应、解决或批量回复 PR 评审意见时,该技能会读取未处理的评论、理解反馈、在合理处修改代码,并撰写回复,全部通过 gh CLI 完成。

主要能力

  • 识别当前分支关联的 PR,或根据用户提供的 PR 编号/URL 定位 PR。
  • 通过 GitHub API 拉取 PR 上的所有评审评论(非 issue 评论)以及评审级别的评论正文。
  • 过滤出未处理的评论:非 PR 作者本人所写、线程中无作者回复、且非机器人评论。
  • 读取评论所在文件的代码上下文,结合 diff_hunk 判断建议是否合理,决定采纳或礼貌保留。
  • 对采纳的评论进行代码修改,并记录修改的文件与对应评论。
  • 为所有评论起草回复,采用谦逊、感谢的语气,采纳的说明具体改动,保留的说明理由。
  • 在发布前以表格形式批量呈现给用户审核,用户可批准、编辑或跳过。
  • 通过 GitHub API 以 in_reply_to 方式在线程内发布回复。

使用方式

触发条件包括:用户想处理或回应 PR 评审评论、说“handle my PR feedback”“fix review comments”“address the PR comments”“respond to reviewer”,或需要批量回复 PR 上所有未解决评论。

前置条件:gh CLI 必须已认证,可用 gh auth status 验证;用户应处于 PR 关联分支,或提供 PR 编号/URL。

核心流程:

  1. 确定 PR 编号,若未指定则运行 gh pr view --json number,title,url -q '.number'。
  2. 拉取评审评论:gh api repos/{owner}/{repo}/pulls/{pr_number}/comments --paginate,以及评审正文:gh api repos/{owner}/{repo}/pulls/{pr_number}/reviews --paginate。
  3. 按 in_reply_to_id 分组线程,过滤出未处理评论。
  4. 读取代码上下文,逐条评估采纳或保留。
  5. 对采纳的评论修改代码。
  6. 起草全部回复,批量呈现给用户审核。
  7. 用户批准后,使用 gh api repos/{owner}/{repo}/pulls/{pr_number}/comments -method POST -f body="..." -F in_reply_to={parent_comment_id} 发布回复。

适用场景

  • 需要回应 PR 评审意见并修改代码。
  • 需要批量回复 PR 上所有未解决的评论线程。
  • 需要处理分支上未解决的评审评论。

不适用场景:创建新 PR 或撰写 PR 描述;评审他人的 PR(属于代码评审,而非回应评论);与 PR 评审评论无关的一般 git 操作。

限制与注意事项

  • 依赖 gh CLI 已安装并认证;未安装时提示 brew install gh,未认证时运行 gh auth login。
  • 回复必须使用 in_reply_to 在线程内发布,不应创建新的顶层评审评论。
  • 多条评论可能影响同一文件甚至同一行,需谨慎处理避免冲突,必要时每次编辑前重新读取文件。
  • 应避免对一切评论都表示同意,需运用判断;回复应保持谦逊,避免防御性语气。
  • 发布回复前必须批量呈现给用户审核,用户保留控制权。
  • 常见错误处理:gh 未找到、HTTP 401、PR 返回 404、回复返回 422、无未处理评论等均有对应解决方式。

参考资料

references/gh-api-reference.md 提供 PR 评审与评论的完整 GitHub API 端点信息。