Користите скупове правила и правила за заштиту грана са ПиГитхуб-ом да бисте омогућили ГитХуб ред спајања

Рационализација процеса спајања помоћу ГитХуб-а: Водич за омогућавање редова за спајање

Како тимови за развој софтвера расту, расте и сложеност њихових Гит токова посла. Управљање вишеструким спремиштима, руковање захтевима за повлачење и обезбеђивање глатке интеграције може бити изазов. Једно од недавних напретка које има за циљ да реши ове проблеме је ГитХубов Редо за спајање. Ова функција вам омогућава да аутоматизујете процес спајања захтева за повлачењем на контролисан и предвидљив начин, обезбеђујући да је код увек ажуран без изазивања сукоба. 🚀

Међутим, омогућавање и конфигурисање Редо за спајање није тако једноставно као окретање прекидача. Захтева коришћење ГитХуб ГрапхКЛ АПИ, посебно преко скупова правила за правилно подешавање. Програмери, попут мене, често се сусрећу са изазовима када покушавају да имплементирају ове функције у великом обиму, посебно када управљају стотинама спремишта. Сећам се да сам заронио дубоко у ГитХуб дискусије и наишао на корисна, али још увек сложена објашњења у вези са редовима за спајање. Али прави трик је разумевање како написати исправну мутацију ГрапхКЛ-а да би се ова функција ефикасно омогућила. 🤔

Моје прво искуство са правилима заштите грана било је помало као слагалица. Успео сам да заштитим гране успешно користећи ГрапхКЛ, али конфигурисање функционалности реда обједињавања захтевало је специфичнији приступ. Циљ овог водича је да вас проведе кроз како да омогућите ред стапања у вашим спремиштима, да се успут позабавите неким уобичајеним препрекама и објасните како ПиГитхуб може играти кључну улогу у поједностављивању ових задатака. Не ради се само о додавању правила, већ о томе да они неометано раде заједно. 💻

У овом посту ћемо истражити процес омогућавања Редо за спајање помоћу ГрапхКЛ АПИ-ја и скупова правила. Видећете како да аутоматизујете правила заштите грана помоћу АПИ позива, па чак и ако се суочавате са изазовима са мутацијама, овај водич ће вам пружити јасноћу. Поред тога, разговараћемо о алтернативама за конфигурисање ове функције, посебно ако тражите практичнији приступ користећи ПиГитхуб уместо да радите директно са ГрапхКЛ-ом. Уз практичне примере и неколико савета за решавање проблема, циљ нам је да ваше ГитХуб искуство учинимо ефикаснијим. 🔧

Како скрипта функционише и за шта се користи

У овој скрипти, циљ је да користите ГитХуб-ов ГрапхКЛ АПИ за конфигурисање правила заштите гране за спремиште. Процес почиње слањем захтева ГитХуб-овом АПИ-ју за преузимање ИД-а спремишта помоћу ГрапхКЛ упита. Ово је неопходно јер је ИД потребан за примену било каквих промена као што је заштита гранања или омогућавање редова за спајање. У функцији `гет_репоситори_ид()`, прави се захтев са именом и власником спремишта, преузимајући јединствени ИД спремишта. АПИ одговара овим ИД-ом, што нам омогућава да наставимо са креирањем правила заштите.

Следећи корак укључује коришћење ИД-а спремишта за примену правила заштите гране. Функција `цреате_бранцх_протецтион_руле()` креира ГрапхКЛ мутацију да би поставила заштиту за грану. У овом случају, грана коју треба заштитити је дефинисана променљивом `БРАНЦХ_ПАТТЕРН`, а правила заштите укључују захтеве као што су одобравање прегледа, обезбеђивање провера статуса и спровођење администраторских дозвола. Ова подешавања су прилагођена на основу потреба спремишта, као што је обезбеђивање спајања само пролазних верзија или спровођење строгих токова рада за одобравање.

Када је мутација дефинисана, скрипта шаље захтев ГитХуб-овом ГрапхКЛ АПИ-ју помоћу методе `рекуестс.пост`. Ово шаље ПОСТ захтев са упитом о мутацији и релевантним параметрима. Ако је захтев успешан, АПИ враћа детаље правила заштите које је креирано. `респонсе.статус_цоде` се проверава да би се осигурало да је операција била успешна, а ако дође до грешке, појављује се изузетак. Овај механизам помаже да се осигура да ако нешто крене наопако, скрипта може упозорити корисника корисном поруком о грешци.

Коначно, скрипта је дизајнирана да буде модуларна и да се може поново користити за више складишта. Ово можете лако скалирати до 100с складишта прилагођавањем параметара као што су `РЕПОСИТОРИ_ОВНЕР` и `РЕПОСИТОРИ_НАМЕ`. Ако треба да примените иста правила заштите на неколико спремишта, скрипта омогућава флексибилност једноставном променом улазних вредности. Поред тога, скрипта је изграђена на начин да се лако може интегрисати у веће токове рада аутоматизације, као што су ЦИ/ЦД цевоводи, где је заштита грана или омогућавање реда за стапање кључна за одржавање доследног квалитета кода у више пројеката. 🚀

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

Омогућавање реда обједињавања са ГитХуб-овим ГрапхКЛ АПИ-јем и скуповима правила

Када управљате великим репозиторијумима, посебно у више тимова и пројеката, постаје кључно имплементирати ред за спајање како бисте поједноставили процес спајања. Ово осигурава да се промене направљене у различитим гранама прегледају, тестирају и интегришу без изазивања сукоба или кршења главне гране. ГитХубов ред за спајање је одлично решење, јер аутоматизује процес спајања захтева за повлачење на безбедан и уредан начин, посебно када се ради са стотинама спремишта. За разлику од традиционалних правила заштите гранања, која намећу провере као што су потребни прегледи и провере статуса, ред стапања омогућава контролисано, секвенцијално спајање захтева за повлачењем, обезбеђујући глаткији ЦИ/ЦД цевовод.

Међутим, омогућавање ове функције за више спремишта захтева добро разумевање ГитХуб-овог ГрапхКЛ АПИ-ја, који олакшава детаљнију контролу над подешавањима спремишта, укључујући омогућавање реда за спајање. Док је процес креирања правила заштите гранања релативно једноставан коришћењем ГрапхКЛ мутација, укључивање функционалности реда обједињавања захтева дубље уроњење у скупове правила. Скупови правила су у суштини алат за конфигурацију унутар ГитХуб-овог ГрапхКЛ АПИ-ја који вам омогућава да примените сложене услове за спајање захтева за повлачење, укључујући аутоматско стављање у ред ПР-ова на основу критеријума које дефинишете.

Интеграцијом скупова правила са функцијом реда за стапање, можете осигурати да се сваки захтев за повлачењем обрађује на уредан начин, избегавајући потенцијална уска грла или грешке у процесу интеграције. Ова функционалност се може применити у више спремишта писањем скрипти за вишекратну употребу које су у интеракцији са ГитХуб-овим ГрапхКЛ АПИ-јем, омогућавајући вам да аутоматизујете примену ових подешавања за стотине складишта у вашој организацији. Кључ за успешно омогућавање реда за спајање лежи у исправном коришћењу мутација АПИ-ја, обезбеђивању да је ред за спајање активиран и руковању разним ивичним случајевима који могу настати током процеса спајања. 🚀