tfgco/codeowners-verifier

codeowners-verifier

一个用于验证CODEOWNERS文件并检查路径是否匹配所有者条目的小工具，适用于CI流程中确保CODEOWNERS覆盖。

Docker镜像

可在以下平台获取：https://hub.docker.com/r/tfgco/codeowners-verifier 和 Quay.io。
可通过--build-arg GOOS=linux --build-arg GOARCH=arm修改GOOS和GOARCH的构建参数。

概述

codeowners-verifier用于验证CODEOWNERS文件中的条目，目前仅支持Gitlab Code Owners。尽管Gitlab和Github的CODEOWNERS工作方式相同（两者执行相同的验证检查），但该工具还会检查文件中的用户和组是否有效。

环境变量

• CODEOWNER_PROVIDER_URL：所选提供者的URL，每个提供者有默认值。
• CODEOWNER_PROVIDER_TOKEN：用于向提供者认证的令牌，无默认值。
• CODEOWNER_PATH：CODEOWNERS文件的路径，无默认值。

这些环境变量也可通过相应的flags定义：--base-url、--codeowners 和 --token。支持同时使用flags和环境变量，但flags值会覆盖环境变量值。

核心功能

1. 验证文件有效性：检查CODEOWNERS文件中的用户和组是否在提供者（如Gitlab）中有效。
2. 检查路径覆盖：验证指定路径是否被CODEOWNERS条目覆盖。
3. 支持忽略规则：可忽略特定用户或组以调整验证结果。

使用场景

• CI/CD流程：在代码提交或合并前自动验证CODEOWNERS文件的正确性。
• 本地开发：快速检查路径是否有对应的代码所有者。
• 团队协作：确保代码变更符合团队的CODEOWNERS规则。

配置说明

命令动词

支持三个动词：help、verify、validate。

Help

显示基本帮助信息，包括可用动词和全局flags。也可用于获取特定动词的帮助：

bash
docker run --rm tfgco/codeowners-verifier help verify

Verify

检查指定路径是否被CODEOWNERS条目覆盖（基于Git仓库的相对路径）。
示例：

bash
docker run --rm -v $(pwd):/workspace -w /workspace tfgco/codeowners-verifier verify dir1/

输出示例：

INFO[0000] Found matching rule on line 7: /**/ [@group1]

支持-i/--ignore flag忽略用户/组（可多次使用或逗号分隔）：

bash
docker run --rm -v $(pwd):/workspace -w /workspace tfgco/codeowners-verifier verify dir1/ -i @user1 --ignore @user2

Validate

验证整个CODEOWNERS文件的有效性（检查用户/组是否在提供者中存在）。需指定提供者名称（如gitlab）：

bash
docker run --rm -e CODEOWNER_PROVIDER_TOKEN=your_token -v $(pwd):/workspace -w /workspace tfgco/codeowners-verifier validate gitlab

输出示例（有效时）：

INFO[0007] Valid CODEOWNERS file

Docker部署示例

docker run示例

验证CODEOWNERS文件（Gitlab）：

bash
docker run --rm \
  -e CODEOWNER_PROVIDER_URL=https://gitlab.com \
  -e CODEOWNER_PROVIDER_TOKEN=your_gitlab_token \
  -e CODEOWNER_PATH=.gitlab/CODEOWNERS \
  -v $(pwd):/workspace \
  -w /workspace \
  tfgco/codeowners-verifier validate gitlab

检查路径覆盖：

bash
docker run --rm \
  -v $(pwd):/workspace \
  -w /workspace \
  tfgco/codeowners-verifier verify src/utils/

docker-compose示例

yaml
version: '3'
services:
  codeowners-verifier:
    image: tfgco/codeowners-verifier
    environment:
      - CODEOWNER_PROVIDER_URL=https://gitlab.com
      - CODEOWNER_PROVIDER_TOKEN=your_token
      - CODEOWNER_PATH=.gitlab/CODEOWNERS
    volumes:
      - ./:/workspace
    working_dir: /workspace
    command: ["validate", "gitlab"]

使用：docker-compose run --rm codeowners-verifier