用途:review-pr 用于评审当前检出的 Pull Request,并将评审结果写入 review.json,由后续工作流负责发布。
前提与输入:工作目录为 PR 分支的检出目录;工作流提供带注解的差异文件 pr_diff.txt 和 PR 描述文件 pr_description.txt。评审只聚焦本 PR 改动的文件和行,不直接向 GitHub 发布评论或评审,不允许运行 gh pr review、gh pr comment、gh api 或其他会向 GitHub 提交内容的命令。
评审范围与优先级:优先关注正确性、安全性、错误处理和有实际意义的性能问题。风格或细节问题仅在能给出具体代码建议块时才提。涉及其未改动代码的疑虑写在 summary 中,而不是行内评论。不提示只为变化构造参数或结构体字段的测试;仅当新测试覆盖不同代码路径或边界情况时才建议新增测试。若 PR 明显是 V0 或初始实现,除非涉及正确性、安全或数据丢失,否则健壮性建议(超时、重试、生命周期管理)应作为可选后续工作而非阻塞项。
差异行注解:pr_diff.txt 中,[OLD:n] 表示旧侧删除行,对应 "LEFT";[NEW:n] 表示新侧新增行,对应 "RIGHT";[OLD:n,NEW:m] 表示未改上下文,使用 "RIGHT" 与行号 m。
评论要求:每条评论正文必须以标签开头:🚨 [CRITICAL] 用于缺陷、安全问题、崩溃或数据丢失;⚠️ [IMPORTANT] 用于逻辑问题、边界情况或缺少错误处理;💡 [SUGGESTION] 用于有价值的改进或更好的模式;🧹 [NIT] 仅用于含建议块的清理项。评论应简洁、直接、可执行,不加称赞或模糊措辞,倾向单行评论,行范围最多 10 行,行内评论只能落在本 PR 的有效改动行上。
建议块:提出代码修改时使用 suggestion 代码块,缩进须与原文件一致,只包含替换代码;多行建议把 start_line 设为第一行,line 设为最后一行。
输出格式:生成 review.json,包含 summary 与 comments 数组。comments 每项含 path(相对仓库根)、line(必填且对应正确侧)、可选的 start_line(仅用于多行范围)、side(LEFT 或 RIGHT)和 body。summary 必须包含 PR 高层概述、重要疑虑以及无法行内评论的未改动代码疑虑、按格式给出的问题计数,以及最终建议 Approve、Approve with nits 或 Request changes。
收尾检查:用 jq 校验 review.json,校验失败须修复为合法 JSON,确认行号与注解差异一致,不向 GitHub 发布任何内容,只输出最终的 review.json。