目录属主 分享链接

简介

CODEOWNERS 文件用于指定项目中哪些用户或团队负责特定文件或目录的更改。与 GitHub、GitLab 等平台一样，GitFox 也支持这个功能，以自动请求代码审查。

创建 CODEOWNERS 文件

1. 文件位置：
   • 将 CODEOWNERS 文件放在仓库的根目录、 或 .gitfox 文件夹中。
2. 文件格式：
   • 每行定义一个文件路径模式及其对应的所有者。
3. 文件大小:
   • 最大不超过4MB

语法格式

# 文件路径模式 所有者1 所有者2
*.js user1@example.org user2@example.org
/docs/ user3@example.org

说明

• 文件路径模式

  使用类似 .gitignore 的文件路径模式。

  * 匹配任意字符串，** 匹配任意目录。

• 所有者

  使用 GitFox 用户邮件（user@mail）

  可以在一条记录里书写多个所有者

  用户邮件必须存在于当前 gitfox 服务器中

示例

# 为所有 JavaScript 文件指定所有者
*.js user1@example.org
# 为文档目录指定所有者
docs/ user2@example.org
# 指定特定代码目录所有者
src/library/** dev1@example.org admin1@example.org
# 指定特定代码文件所有者
src/library/admin/* admin1@example.org

注意事项

• 优先级：
  • 越具体的路径模式优先级越高。
• 评论：
  • 使用 # 添加注释。
• 所有者权限：
  • 所有者必须对仓库有读访问权限。

使用场景

• 推送检查
  • 在代码库 设置 -> 高级设置 里开启 目录属主推送
  • 如果提交的代码里包含了CODEOWNERS 中约定的文件，则只有指定的用户才能推送成功
• 合并请求
  • 在代码库 规则 里新增一条规则，选中需要代码所有者审查 后保存
  • 发起合并请求后，如果匹配到了 CODEOWNERS 文件规则，会将对应的 Owner 用户加入到代码评审人员中
  • 有任一 Owner 用户进行了评审，该文件的审查即通过
  • 若文件仅有一位Owner，则必须由其审核

通过正确配置 CODEOWNERS，可以有效管理代码审查流程，确保代码质量和责任的清晰划分。