谁来审这段代码:用 CODEOWNERS 按目录自动指派评审人

简介: 改了某个目录的代码,可以按路径自动找到该负责的人来评审。AngusGit 读取仓库里的 CODEOWNERS 文件,打开开关后,新建拉取请求时就会把对应的人加为评审人。文件怎么写、开关在哪、它和默认评审人怎样一起生效,用 xlliu/test-pr-example #9 对照。

这篇讲怎么按目录自动指定谁来评审。看完你可以写一份 CODEOWNERS 文件,按路径写明每段代码由谁负责,打开 启用 CODEOWNERS 之后,新建拉取请求就会按改动路径把这些人加为评审人。

下文以仓库 xlliu/test-pr-example 对照。这个仓库已经打开 需要代码评审 和 需要所有评审人通过(被指派的人都批准才能合并),但 启用 CODEOWNERS 还是关的。它设置了两位默认评审人,也就是在仓库设置里固定指定、每条新拉取请求都会带上的人:一位显示名是 Angus、登录名是 xlliu,另一位是 admin。

同一文件命中多行时用最后一行;这个仓库还没放 CODEOWNERS

1. 现在这条拉取请求是怎么来的

还开着的 #9 标题是 docs: 说明空购物车不计算折扣,从 feature/link-empty-cart 合向 main,作者是 Angus,正文写了 Closes #4,只改了 1 个文件:docs/empty-cart-note.md(+3 -0)。

评审人是 Angus 和 admin,两人都是 待评审。合并卡片写着「此拉取请求尚未准备好合并」,下面是「暂无状态检查」和「仍有评审未完成,需等待评审通过后才能合并」,所以 合并拉取请求 是灰的。

#9:Angus 和 admin 都待评审,合并按钮不可用

所以这两位来自仓库设置里的默认评审人,不是按文件路径算出来的;main 上目前也没有 .github/CODEOWNERS、根目录 CODEOWNERS 或 docs/CODEOWNERS。

2. CODEOWNERS 实际会做什么

CODEOWNERS 只在新建拉取请求时算一次,而且仓库要先打开 需要代码评审;创建之后再往源分支推提交,不会按新文件补评审人。

指派时会做两件事,再去重:

  1. 放上设置里的默认评审人。
  2. 启用 CODEOWNERS 开着时,再读目标分支上的文件,按这次改动的路径追加人。

所以默认名单里已经有的人,文件里再写一次也不会变成两行评审。这个仓库的默认名单已经是 xlliu 和 admin 两个人。文件里如果也只写这两位,打开开关后新建的拉取请求,评审人还是这两位。

能做 做不到
创建拉取请求时,把默认评审人和路径匹配到的人并在一起 拉取请求创建后再推送,不会重新算、也不会补人
只认 @登录名 团队名(中间有 /)和邮箱会被跳过
配合 需要所有评审人通过,被指派的人都批准才能合并 只开 CODEOWNERS、不开这一项时,CODEOWNERS 自己不拦合并

作者自己被指派时,不再给自己发「请求评审」通知。其他评审人会收到。

3. 文件怎么写

CODEOWNERS 文件可以放在三个位置,按下面的顺序找,用找到的第一个:

  1. .github/CODEOWNERS
  2. 仓库根目录的 CODEOWNERS
  3. docs/CODEOWNERS

读的是拉取请求目标分支上的文件。要合进 main,就得先把文件合进 main。只改在自己的分支上,对这条拉取请求不起作用。

下面这份是给这个仓库准备的示例,还没有提交。登录名用 @xlliu,不要写显示名 @Angus。

# 没被后面规则盖住的文件
*                  @xlliu

# 根目录下的 service 目录
/service/          @admin

# 任意目录的 SQL,写在后面,盖住前面的规则
*.sql              @xlliu @admin

# 开头和行尾的注释会被拿掉,空行忽略。路径和人之间用空格分开。

写法 匹配
* 所有文件。单独一行时做兜底
/service/ 从仓库根目录算的 service 目录,以及里面的文件。开头的 / 表示锚定到根
*.sql 任意一层目录里、以 .sql 结尾的文件
/docs/**/*.md docs 下任意层级的 .md
? 一个不是斜杠的字符。v?.txt 能对上 v1.txt

同一个文件命中多行时,用最后一行。

  • docs/empty-cart-note.md 只命中 *,人是 @xlliu。
  • service/Foo.java 先命中 *,再命中 /service/,留下 @admin。
  • service/db/init.sql 三行都命中,最后一行是 *.sql,留下 @xlliu 和 @admin。

以 ! 开头不会当成排除。方括号不会当成字符集,只按字面量里的括号去匹配。

4. 开关在哪

入口是 仓库设置 → 拉取请求,地址带 ?tab=settings&section=pullrequests。

需要所有评审人通过开着,启用 CODEOWNERS 关着

这次看到的是:

项 状态
需要代码评审 开。说明是「合并前必须经过代码评审,开启后针对所有分支都生效。」
需要的评审人数 1
评审人 已选择 2 个:Angus、admin
需要解决所有评论 关
需要所有评审人通过 开。说明是「合并前所有指派的评审人都必须通过评审。」
启用 CODEOWNERS 关。说明是「根据 .github/CODEOWNERS 文件按代码路径自动指派评审人。」
评审通过后自动合并 开。还要这条拉取请求自己也打开自动合并才会合。#9 的合并按钮仍是灰的
自动指派评审人(负载均衡) 关
评审超时提醒(小时) 0,表示关闭

打开 需要代码评审 时,人数至少为 1,并且至少选一位评审人,否则保存会提示「启用代码评审时,必须设置评审人数并选择至少一个评审人」。保存成功的提示是「拉取请求设置已保存」。页面上已经是这些值时,打开设置只是查看,不必再保存。

负载均衡开着、而且候选人数多于 需要的评审人数 时,只留下未完成评审最少的那几位,人数等于所需人数。代码所有者可能被挑掉。这个仓库它是关的,两位默认评审人都会留下。

需要所有评审人通过 看的是已经指派的每一个人,包括默认评审人和 CODEOWNERS 追加的人。人数设成 1 时,如果没开「所有人通过」,一位批准就够人数。这个仓库开了「所有人通过」,所以 #9 要等 Angus 和 admin 都批准。页面上现在的红字是「仍有评审未完成,需等待评审通过后才能合并」。合并请求若仍然发出去,接口返回的是「需要所有评审人通过后才能合并,当前仍有「1」个评审人未通过」。#9 还开着,等两位评审人都通过再合并。

5. 和分支保护

仓库设置里的 需要代码评审 管的是拉取请求能不能合,并不阻止直接往 main 推。这个仓库的 设置 → 分支保护 写着「尚未设置分支保护规则」;要拦住直接推送、让改动必须走拉取请求,再点 添加规则,给 main 打开需要评审,并对管理员同样生效。做法见文末的分支保护一文。

合并时如果目标分支的保护规则里填了评审人数,用保护规则上的人数;没填才用仓库设置里的 需要的评审人数。需要所有评审人通过 仍看仓库设置。

6. 没有按路径指派时

你看到的 原因 怎么处理
只有默认评审人 启用 CODEOWNERS 关着,或目标分支上三个位置都没有文件。#9 就是前一种 把文件合进目标分支,打开开关,保存后再新建一条拉取请求
文件里写了人,评审列表里没有 @ 后面不是登录名,或写了团队名、邮箱 改成 @xlliu 这种登录名。显示名 Angus 对不上
指派的不是预想的那一行 同一个文件命中了多行,生效的是最后一行 把更具体的规则放到后面,或把几个人写在同一行
创建后又改了别的目录,新人没出现 只在创建时算一次 由作者或管理员手工把这个人加为评审人
人还没批准就被合并了 需要所有评审人通过 关着,而且批准人数已经达到所需人数 打开「所有人通过」。这个仓库已经开着

常见问题

CODEOWNERS 里的人没有仓库权限会怎样?

他仍会被加进评审人。要打开拉取请求并提交评审,需要这个仓库的读取权限。

社区版能用吗?

能。需要代码评审、启用 CODEOWNERS 和 需要所有评审人通过 都在仓库 设置 → 拉取请求 里。

两个人里任意一个批准就行,能做到吗?

把两个人写在同一行,关掉 需要所有评审人通过,需要的评审人数 填 1,并保持负载均衡关闭。这样一位批准就够人数。代价是:任何一位已指派的人批准都算数,不限是不是代码所有者。这个仓库现在开着「所有人通过」,所以不是这种算法。

小结

xlliu/test-pr-example 没有 CODEOWNERS 文件,启用 CODEOWNERS 是关的。#9 的评审人 Angus 和 admin 来自默认名单。两人都还是待评审,合并按钮不可用。

要按目录加人:把 .github/CODEOWNERS 合进目标分支,规则用 @登录名,同一文件以最后一行为准;然后打开 启用 CODEOWNERS 并保存。新建的拉取请求会把文件里匹配到的人和默认评审人并在一起。这个仓库已经打开 需要所有评审人通过,负载均衡是关的,被指派的人都要批准。

结论: 默认评审人在创建拉取请求时就会指派。CODEOWNERS 要文件先在目标分支上,并且打开启用开关,才会按路径把登录名并进去。需要所有评审人通过开着时,这些人都批准才能合并。

相关文章
|
23天前
|
jenkins 持续交付 开发工具
从 GitLab 迁到 AngusGit:迁移清单、双跑和回滚
团队从 GitLab 整体切到 AngusGit,难的不是推送几个仓库,而是切换那天谁都不丢代码、出了问题能退回去。按准备、首次同步、双跑、切换日、回滚五个阶段,给出每一步要做什么、怎么验收,以及分支保护为什么要放在最后一次同步之后再打开。
从 GitLab 迁到 AngusGit:迁移清单、双跑和回滚
|
23天前
|
Java 开发工具 git
导入 GitHub Actions 之后:事件、密钥和 Runner 还要对一遍
把 GitHub Actions 的 workflow 贴进「导入 GitHub Actions」之后,先对照未映射清单和注意清单,核对触发事件、密钥和运行器有没有变。示例转换后的初稿名叫 CI,runs-on 会变成 NATIVE,types 和 Job 超时都不会映射,核对完再创建流水线。
|
1月前
|
缓存 安全 数据安全/隐私保护
云上免费 Docker 镜像仓怎么起步:推送、拉取与公开浏览
用 AngusRepo 云服务托管私有镜像:login 后推送到 HOSTED,按需拉取;对外用公开浏览页匿名 pull。
|
1月前
|
人工智能 缓存 安全
用 AI 助手只读查制品库:AngusRepo MCP 怎么接入
Coding Agent 要在对话里问「这个坐标在哪个仓、依赖和漏洞计数是什么」,并不需要把 mvn npm docker 搬进模型上下文。AngusRepo 把这条能力做成进程内的 MCP 只读端点:宿主连上之后调用具名工具,服务端回环本进程管理 API,返回元数据投影。
|
14天前
|
人工智能 JSON 自然语言处理
YAML契约的模板:用7个字段,把"绝对不能"变成机器执行的规则
7个字段把"绝对不能"变成机器执行的规则:意图编号、版本、描述、语义域、适用产品、语义令牌、机器约束与不可变边界。写法是查字典填表格,值必须引用语义字典已注册项,自创被入库安检拦下。每条边界带违反动作,分阻断与警告两级,编译后变成指令前缀、类型规则、走查清单与拦截规则四种形态。
|
22天前
|
消息中间件 监控 中间件
日志监控正在失效?从日志海洋到可观测性中枢的实战指南
传统日志监控因日志爆炸、缺乏上下文、工具割裂和人工滞后而失效。升级需聚焦集中化采集、结构化解析与指标/链路融合,实现秒级搜索、开箱即用解析及统一可观测性,将排障从“大海捞针”变为标准化流程。
|
25天前
|
人工智能 JSON 自然语言处理
设计师与产品经理的消费路径:从被动遵守到主动走查
设计师的6字段快照是契约的原材料,契约编译出的Checklist是设计师的外置记忆。规则不再靠个人经验口口相传,机器自动编译、自动同步、自动拦截,设计师从被动遵守长成主动走查,从规则的消费者长成规则的活水源头。
|
15天前
|
人工智能 测试技术 开发工具
AngusTester 是什么:一个自动化测试平台,一份 YAML测试 Anything,计划和结果在一处
AngusTester 是一个自动化测试平台。一份 YAML 描述接口、性能、页面、移动端和模型调用,计划、用例和报告在同一处。脚本由执行节点上的 Agent 运行。
AngusTester 是什么:一个自动化测试平台,一份 YAML测试 Anything,计划和结果在一处
|
15天前
|
安全 Java Maven
AngusRepo 是什么:一个制品仓库,涵盖 28 种常见格式,客户端拉取和发布时只改地址
AngusRepo 是一个制品仓库。28 种常见格式可以托管、代理或聚合成一个地址。mvn、npm、docker 仍用原来的命令,改的是仓库地址。制品留在你这次安装里。
AngusRepo 是什么:一个制品仓库,涵盖 28 种常见格式,客户端拉取和发布时只改地址
|
16天前
|
安全 网络安全 开发工具
AngusGit 是什么:一个代码托管与协作平台,保护分支和合并请求,需要时再 CI 构建
AngusGit 是一个代码托管与协作平台。用 SSH 或 HTTPS 推代码,用保护分支和合并请求做评审,需要构建时再跑同一套账号下的流水线。仓库留在你自己的磁盘上。
AngusGit 是什么:一个代码托管与协作平台,保护分支和合并请求,需要时再 CI 构建