mergermarket/dependabot-access

dependabot-access

镜像概述

dependabot-access是一个用于配置GitHub仓库中Dependabot访问权限的容器工具。它允许通过JSON文件定义哪些仓库可以访问Dependabot，并验证仓库状态及用户权限，确保配置的准确性。

核心功能与特性

• Dependabot权限配置：通过JSON文件定义仓库对Dependabot的访问权限
• 仓库规则定义：支持在JSON文件中指定仓库列表及对应的应用访问权限
• 权限验证：自动检查JSON文件中包含的仓库是否为已归档状态或用户是否具备管理员权限
• 错误提示：当检测到无效仓库（如已归档）或用户权限不足时，生成明确的错误信息

使用场景与适用范围

• GitHub组织中需要统一管理多个仓库的Dependabot访问权限
• 开发团队希望标准化依赖更新工具（Dependabot）的访问配置
• 需要批量配置或更新仓库的Dependabot权限设置

使用方法与配置说明

环境准备

需设置环境变量GITHUB_TOKEN，该token需具有目标仓库的管理员权限。

bash
export GITHUB_TOKEN=my-team-member-github-token

Docker运行命令

bash
docker run -i -w $PWD -v $PWD:$PWD -e GITHUB_TOKEN docker.xuanyuan.run/mergermark/dependabot-access \
    --org my-github-org \
    --access access.json \
    --dependabot-id 12345 \
    --account-id 67890

参数说明

• --org：GitHub组织名称（必填）
• --access：包含仓库访问规则的JSON文件路径（必填）
• --dependabot-id：Dependabot应用的ID（必填）
• --account-id：GitHub账户ID（必填）

access.json配置文件

该文件用于定义仓库访问规则，格式如下：

json
[
  {
    "repos": [ "repo1", "repo2" ],
    "apps": {
      "dependabot": true
    }
  }
]

• repos：仓库名称列表（字符串数组）
• apps：应用访问权限配置，dependabot: true表示允许Dependabot访问指定仓库

更多配置示例可参考tests/fixtures/access.json。

错误处理

容器会对以下情况产生错误提示：

• access.json中包含已归档的仓库
• 当前用户（通过GITHUB_TOKEN验证）对指定仓库没有管理员权限