将规则集和分支保护规则与 PyGithub 结合使用以启用 GitHub 合并队列

通过规则集和 GraphQL API 启用 GitHub 合并队列

GraphQL API 使用 GitHub 存储库中的规则集自动启用合并队列

import requests
GITHUB_API_URL = 'https://api.github.com/graphql'
TOKEN = 'your_token_here'
headers = {
    "Authorization": f"Bearer {TOKEN}",
    "Content-Type": "application/json"
}
# Repository and Branch details
REPOSITORY_OWNER = "your_owner_name"
REPOSITORY_NAME = "your_repo_name"
BRANCH_PATTERN = "main"
# GraphQL mutation for creating a merge queue rule
mutation = """
mutation($repositoryId: ID!, $branchPattern: String!) {
  createMergeQueueRule(input: {
    repositoryId: $repositoryId,
    pattern: $branchPattern,
    requiresStatusChecks: true,
    allowsMergeQueue: true,
  }) {
    mergeQueueRule {
      id
      pattern
      requiresStatusChecks
      allowsMergeQueue
    }
  }
}"""
# Query to fetch repository ID
repository_query = """
query($owner: String!, $name: String!) {
  repository(owner: $owner, name: $name) {
    id
  }
}"""
def get_repository_id():
    variables = {"owner": REPOSITORY_OWNER, "name": REPOSITORY_NAME}
    response = requests.post(
        GITHUB_API_URL,
        json={"query": repository_query, "variables": variables},
        headers=headers
    )
    if response.status_code == 200:
        return response.json()["data"]["repository"]["id"]
    else:
        raise Exception(f"Failed to fetch repository ID: {response.json()}")
def enable_merge_queue(repository_id):
    variables = {
        "repositoryId": repository_id,
        "branchPattern": BRANCH_PATTERN,
    }
    response = requests.post(
        GITHUB_API_URL,
        json={"query": mutation, "variables": variables},
        headers=headers
    )
    if response.status_code == 200:
        print("Merge queue rule created:", response.json()["data"]["createMergeQueueRule"]["mergeQueueRule"])
    else:
        raise Exception(f"Failed to create merge queue rule: {response.json()}")
# Execute
try:
    repository_id = get_repository_id()
    enable_merge_queue(repository_id)
except Exception as e:
    print("Error:", e)

使用 PyGithub 管理合并队列的替代方法

使用 PyGithub 在多个存储库中启用具有分支保护规则的合并队列

from github import Github
import os
# GitHub access token and repository details
GITHUB_TOKEN = os.getenv('GITHUB_TOKEN')
g = Github(GITHUB_TOKEN)
# Define the repository and branch pattern
repo_name = "your_repo_name"
branch_name = "main"
# Get the repository object
repo = g.get_repo(repo_name)
# Fetch the branch protection rule
branch = repo.get_branch(branch_name)
protection = branch.get_protection()
# Update branch protection to enable merge queue
protection.update(
    required_status_checks={"strict": True, "contexts": []},
    enforce_admins=True,
    allow_force_pushes=False,
    dismiss_stale_reviews=True,
    required_pull_request_reviews={"dismissal_restrictions": {}, "require_code_owner_reviews": True},
    merge_queue_enabled=True
)
# Display status
print(f"Merge queue enabled for branch {branch_name}")

本指南介绍了使用 GraphQL API 和 规则集 在 GitHub 上为多个存储库启用 合并队列 的过程。本文解释了如何通过脚本自动执行此过程，并探讨了启用合并队列的正确突变的问题。我们还讨论了 PyGithub 对于此类任务的限制，以及如何使用 GitHub 强大的 GraphQL 工具来解决这些限制。这可以极大地简化工作流程并改善大型团队的存储库管理。 🚀

提高工作流程效率

为大型团队和组织实施合并队列可以显着提高管理多个拉取请求的效率。通过利用 GitHub 的 GraphQL API，您可以自动执行合并规则并确保仅合并有效的、经过审核的更改。这种自动化可以大大减少合并冲突和手动干预，特别是在处理不同存储库的多个活动拉取请求时。合并队列确保拉取请求以有序的方式合并，从而提高整体代码质量。

此外，将规则集与合并队列结合使用会增加一层控制，允许您为每个存储库定义自定义合并规则。这种灵活性对于具有不同需求的大型团队至关重要。通过 GraphQL 突变，您可以为每个存储库设置特定参数，实施更严格的控制，例如要求在合并 PR 之前通过构建或代码审查。随着团队规模的扩大和工作流程变得更加复杂，此类控制对于维护稳定和安全的代码库至关重要。 😊