PyGithub でルールセットとブランチ保護ルールを使用して GitHub マージ キューを有効にする

ルールセットとGraphQL APIを介したGitHubマージキューの有効化

GitHub リポジトリのルールセットを使用してマージ キューの有効化を自動化する GraphQL API

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 がマージされる前にビルドやコード レビューを渡す必要があるなど、より厳密な制御を適用できます。このような制御は、チームが拡大し、ワークフローが複雑になるにつれて、安定した安全なコードベースを維持するために不可欠です。 😊