Használja a szabálykészleteket és az elágazásvédelmi szabályokat a PyGithub segítségével a GitHub összevonási sor engedélyezéséhez

Az egyesítési folyamatok ésszerűsítése a GitHub segítségével: Útmutató az egyesítési várólisták engedélyezéséhez

Ahogy a szoftverfejlesztő csapatok nőnek, úgy nő a Git-munkafolyamataik összetettsége is. A több adattár kezelése, a lehívási kérelmek kezelése és a zökkenőmentes integráció biztosítása kihívást jelenthet. Az egyik közelmúltbeli fejlesztés, amely ezeket a problémákat kívánja megoldani, a GitHub Merge Queue-ja. Ez a funkció lehetővé teszi a lekérési kérelmek egyesítésének folyamatát ellenőrzött és kiszámítható módon automatizálva, biztosítva, hogy a kód mindig naprakész legyen anélkül, hogy ütközéseket okozna. 🚀

Az Összevonási sor engedélyezése és konfigurálása azonban nem olyan egyszerű, mint egy kapcsoló megfordítása. A megfelelő beállításhoz a GitHub GraphQL API használatát igényli, különösen a szabálykészleteken keresztül. A fejlesztők, hozzám hasonlóan, gyakran szembesülnek kihívásokkal, amikor megpróbálják ezeket a szolgáltatásokat nagymértékben megvalósítani, különösen több száz adattár kezelésekor. Emlékszem, hogy mélyen belemerültem a GitHub-beszélgetésekbe, és hasznos, de még mindig összetett magyarázatokba botlottam az egyesítési sorokkal kapcsolatban. De az igazi trükk az, hogy megértsük, hogyan írjuk meg a megfelelő GraphQL-mutációt a funkció hatékony engedélyezéséhez. 🤔

Az első tapasztalatom az ágvédelmi szabályokkal kicsit olyan volt, mint egy rejtvény. Sikeresen meg tudtam védeni az ágakat a GraphQL használatával, de az összevonási sor funkciójának konfigurálása konkrétabb megközelítést igényelt. Ennek az útmutatónak az a célja, hogy végigvezeti Önt, hogyan engedélyezheti az egyesítési sort a tárolókban, feloldja néhány gyakori útlezárást, és elmagyarázza, hogy a PyGithub hogyan játszhat kulcsszerepet ezeknek a feladatoknak az egyszerűsítésében. Ez nem csak a szabályok hozzáadásáról szól, hanem arról, hogy azok zökkenőmentesen működjenek együtt. 💻

Ebben a bejegyzésben megvizsgáljuk a egyesítési sor engedélyezésének folyamatát GraphQL API-k és szabálykészletek használatával. Látni fogja, hogyan automatizálhatja az ágvédelmi szabályokat API-hívásokkal, és még ha mutációkkal is szembesül, ez az útmutató egyértelművé teszi. Ezenkívül megvitatjuk a funkció beállításának alternatíváit, különösen akkor, ha gyakorlatiasabb megközelítést keres a PyGithub használatával ahelyett, hogy közvetlenül a GraphQL-lel dolgozna. Gyakorlati példákkal és néhány hibaelhárítási tipptel arra törekszünk, hogy hatékonyabbá tegyük a GitHub-élményt. 🔧

Hogyan működik a szkript és mire használják

Ebben a szkriptben az a cél, hogy a GitHub GraphQL API-ját használjuk az elágazásvédelmi szabályok konfigurálására egy adattárhoz. A folyamat azzal kezdődik, hogy egy GraphQL-lekérdezés segítségével kérést küldünk a GitHub API-jának a lerakatazonosító lekérésére. Ez elengedhetetlen, mert az azonosítóra szükség van minden változtatás alkalmazásához, például az ágvédelemhez vagy az egyesítési sorok engedélyezéséhez. A `get_repository_id()` függvényben egy kérés történik a lerakat nevével és tulajdonosával, lekérve a lerakat egyedi azonosítóját. Az API ezzel az azonosítóval válaszol, így folytathatjuk a védelmi szabályok létrehozását.

A következő lépésben a lerakatazonosítót kell használni az ágvédelmi szabályok alkalmazásához. A `create_branch_protection_rule()` függvény egy GraphQL mutációt hoz létre az ág védelmének beállításához. Ebben az esetben a védendő ágat a "BRANCH_PATTERN" változó határozza meg, és a védelmi szabályok olyan követelményeket tartalmaznak, mint a felülvizsgálatok jóváhagyása, az állapotellenőrzés biztosítása és az adminisztrátori engedélyek érvényesítése. Ezek a beállítások a lerakat igényei alapján vannak testreszabva, például annak biztosítása, hogy csak az áthaladó buildek egyesülhessenek, vagy szigorú jóváhagyási munkafolyamatokat kényszerítsenek ki.

A mutáció meghatározása után a szkript kérést küld a GitHub GraphQL API-jának a "requests.post" metódus használatával. Ez elküld egy POST kérést a mutációs lekérdezéssel és a vonatkozó paraméterekkel. Ha a kérés sikeres, az API visszaadja a létrehozott védelmi szabály részleteit. A `response.status_code` ellenőrzi, hogy a művelet sikeres volt-e, és ha bármilyen hiba történik, kivételt teszünk. Ez a mechanizmus segít abban, hogy ha bármi elromlik, a szkript egy hasznos hibaüzenettel riaszthassa a felhasználót.

Végül a szkriptet úgy tervezték, hogy moduláris legyen, és több tárolóhoz is újrafelhasználható legyen. Könnyedén méretezheti ezt akár 100 adattárra is az olyan paraméterek módosításával, mint a `REPOSITORY_OWNER` és a `REPOSITORY_NAME`. Ha ugyanazokat a védelmi szabályokat kell alkalmaznia több tárolóban, a szkript rugalmasságot tesz lehetővé a bemeneti értékek egyszerű megváltoztatásával. Ezenkívül a szkriptet úgy építették fel, hogy könnyen integrálható nagyobb automatizálási munkafolyamatokba, például CI/CD-folyamatokba, ahol az ágak védelme vagy az egyesítési sor engedélyezése kulcsfontosságú a több projekten keresztüli egységes kódminőség megőrzéséhez. 🚀

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)

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}")

A Merge Queue engedélyezése a GitHub GraphQL API-jával és szabálykészleteivel

Nagy adattárak kezelésekor, különösen több csapaton és projekten keresztül, kulcsfontosságúvá válik az egyesítési sor megvalósítása az egyesítési folyamat egyszerűsítése érdekében. Ez biztosítja, hogy a különböző ágakban végrehajtott változtatások áttekintésre, tesztelésre és integrálásra kerüljenek anélkül, hogy konfliktusokat okoznának vagy a fő ágat megtörnék. A GitHub merge queue kiváló megoldás, mivel biztonságosan és rendezetten automatizálja a lekérési kérelmek egyesítésének folyamatát, különösen akkor, ha több száz adattárral foglalkozik. A hagyományos elágazásvédelmi szabályokkal ellentétben, amelyek olyan ellenőrzéseket hajtanak végre, mint a kötelező felülvizsgálatok és állapotellenőrzések, az összevonási sor lehetővé teszi a lekérési kérelmek ellenőrzött, szekvenciális összevonását, biztosítva a zökkenőmentesebb CI/CD folyamatot.

Ennek a funkciónak a több adattárhoz való engedélyezése azonban megköveteli a GitHub GraphQL API alapos megértését, amely lehetővé teszi a lerakatbeállítások részletesebb szabályozását, beleértve az egyesítési sor engedélyezését. Míg az elágazásvédelmi szabályok létrehozásának folyamata viszonylag egyszerű a GraphQL-mutációk használatával, az összevonási sor funkcióinak beépítése a szabálykészletek mélyebb megismerését igényli. A szabálykészletek alapvetően egy konfigurációs eszköz a GitHub GraphQL API-jában, amelyek lehetővé teszik a lekérési kérelmek egyesítésének összetett feltételeinek érvényesítését, beleértve a PR-k automatikus sorba állítását az Ön által meghatározott feltételek alapján.

A szabálykészletek integrálásával az összevonási sor funkcióval biztosíthatja, hogy minden lekérési kérést rendezett módon kezeljenek, elkerülve az integrációs folyamat esetleges szűk keresztmetszeteit vagy hibáit. Ez a funkció több adattárban is megvalósítható, ha újrafelhasználható szkripteket írnak, amelyek kölcsönhatásba lépnek a GitHub GraphQL API-jával, lehetővé téve, hogy automatizálja e beállítások betartatását a szervezet több száz adattárában. Az egyesítési sor sikeres engedélyezésének kulcsa az API mutációinak megfelelő felhasználása, az összevonási sor aktiválásának biztosítása, valamint az egyesítési folyamat során esetlegesen felmerülő különböző élesetek kezelése. 🚀