配置审查
自动审查
选择 HeyDeer 是否自动审查 PR,以及审查频率。新工作区一开始为仅手动。设置工作区的人首次打开 HeyDeer 时,工作区会切换为每次推送时审查,并显示这项设置供其修改。在此之前,只有在有人发起审查时,HeyDeer 才会审查。
审查时机
| 审查时机 | 行为 |
|---|---|
| 仅手动 | 只有在有人发起审查时,HeyDeer 才会审查:可以在 HeyDeer 中发起、在 PR 评论中发起,或在检查上点击“审查此版本”。 |
| 每个 PR 审查一次 | HeyDeer 会审查符合筛选条件的 PR,直到成功完成一次审查。 |
| 每次推送时审查 | PR 第一次符合筛选条件时审查一次,之后每次推送新提交都会再审查。 |
开启自动审查
- 打开工作区设置 → 审查规则。
- 在何时审查下,选择每个 PR 审查一次或每次推送时审查。
- 选择保存工作区审查规则。
如需为某个仓库使用不同的审查时机,请在该仓库的审查规则中修改。参见设置如何生效。
哪些 PR 符合条件
审查时机只适用于符合自动审查筛选条件的 PR。默认情况下,HeyDeer 会跳过草稿、来自 Fork 的 PR,以及 Dependabot、Renovate 等机器人提交的依赖更新。参见自动审查筛选条件。
要停止某个 PR 的自动审查,请评论 @heydeer pause。参见 PR 评论命令。
每个 PR 审查一次
- 只要成功完成一次审查(无论是自动审查还是手动发起的审查),就算用掉了“每个 PR 审查一次”,即使该审查报告了发现的问题。
- 失败和已取消的审查不计入。在成功完成一次审查之前,新的推送会取代尚未完成的自动审查。
- 此后,推送或重新打开 PR 都不会发起审查。如需再次审查,请评论
@heydeer review。
每次推送时审查
新推送会取消尚未完成的自动审查,改为审查最新提交。
默认情况下,首次审查之后的每次审查只覆盖自上次审查以来的改动。参见后续审查。
每个 PR 的自动审查次数上限
选择每次推送时审查时,PR 成功完成这么多次自动审查(包括第一次)后,HeyDeer 会停止自动审查该 PR。默认为 5 次;可选 1、2、3、5、10、20 或不限次数。
手动发起的审查会计入“每个 PR 审查一次”,但不计入此上限;达到上限后,仍可以手动发起审查。
PR 关闭后停止自动审查
默认开启。PR 关闭或合并后,HeyDeer 会停止其排队中和运行中的自动审查。你手动发起的审查会继续运行。