如何配置GitHub仅在合并队列执行CI检查及批量启用合并队列

要实现CI检查只在合并队列触发，直接修改GitHub Actions工作流的触发事件即可：

• 打开你的CI工作流文件（通常在.github/workflows/目录下）
• 将原来的pull_request触发事件替换为merge_group，示例配置如下：

name: Merge Queue CI
on:
  merge_group:  # 仅在合并队列触发
jobs:
  build-and-test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      # 你的CI步骤（构建、测试等）

• 如果你之前的工作流同时触发pull_request和merge_group，直接移除pull_request即可。

另外，记得调整分支保护规则：

1. 进入仓库的「Settings」→「Branches」→「Branch protection rules」
2. 找到目标分支的保护规则，在「Require status checks to pass before merging」中，选择你刚才配置的合并队列CI任务
3. 不需要勾选PR相关的检查项，确保只有合并队列的CI通过才能完成合并。

可以通过GitHub REST API实现批量启用，核心是操作仓库的分支保护规则，具体步骤如下：

所需权限 #

• 个人访问令牌（PAT）需要拥有repo权限（私有仓库）或public_repo权限（公共仓库）
• 令牌持有者需要是仓库的管理员或拥有分支保护配置权限

API端点说明 #

使用PATCH（更新现有分支保护规则）或PUT（创建新的分支保护规则）请求：

• 端点：https://api.github.com/repos/{owner}/{repo}/branches/{branch}/protection
• 请求体中设置merge_queue.enabled: true

单个仓库启用示例（curl） #

curl -X PATCH \
  -H "Authorization: token YOUR_GITHUB_PAT" \
  -H "Accept: application/vnd.github+json" \
  https://api.github.com/repos/你的组织名/仓库名/branches/main/protection \
  -d '{"merge_queue":{"enabled":true}}'

如果目标分支还没有分支保护规则，需要用PUT请求创建并启用：

curl -X PUT \
  -H "Authorization: token YOUR_GITHUB_PAT" \
  -H "Accept: application/vnd.github+json" \
  https://api.github.com/repos/你的组织名/仓库名/branches/main/protection \
  -d '{
    "required_status_checks": null,
    "enforce_admins": null,
    "required_pull_request_reviews": null,
    "merge_queue": {"enabled": true}
  }'

批量处理脚本示例（Python） #

编写脚本遍历仓库列表，批量调用API：

import requests

# 配置参数
GITHUB_TOKEN = "你的PAT令牌"
ORG_NAME = "你的组织名"
TARGET_BRANCH = "main"
REPO_LIST = ["仓库1", "仓库2", "仓库3"]  # 替换为你的仓库列表

headers = {
    "Authorization": f"token {GITHUB_TOKEN}",
    "Accept": "application/vnd.github+json"
}

for repo in REPO_LIST:
    url = f"https://api.github.com/repos/{ORG_NAME}/{repo}/branches/{TARGET_BRANCH}/protection"
    # 尝试更新现有规则
    response = requests.patch(url, json={"merge_queue": {"enabled": True}}, headers=headers)
    
    if response.status_code == 404:
        # 分支无保护规则，创建新规则
        create_data = {
            "required_status_checks": None,
            "enforce_admins": None,
            "required_pull_request_reviews": None,
            "merge_queue": {"enabled": True}
        }
        response = requests.put(url, json=create_data, headers=headers)
    
    if response.ok:
        print(f✅ 成功为 {repo} 启用合并队列")
    else:
        print(f❌ {repo} 启用失败: {response.json().get("message")}")

内容的提问来源于stack exchange，提问作者ConscriptMR