Przewodnik: Uruchamianie przepływów pracy Git w tym samym programie uruchamiającym

Koordynowanie przepływów pracy GitHub na Shared Runnerach

Zarządzanie wieloma przepływami pracy w GitHub Actions może być wyzwaniem, szczególnie gdy chcesz, aby działały na tym samym, własnym serwerze biegacza. W scenariuszach, w których masz oddzielne pliki YAML dla różnych przepływów pracy, np. codeql.yml i snyk-zap.yml, zapewnienie ich działania na tym samym serwerze z określonej grupy może być trudne.

Celem jest wykorzystanie tego samego modułu biegacza w obu przepływach pracy bez jawnego nadawania mu nazwy, co pozwoli uniknąć konfliktów z innymi przepływami pracy. W tym przewodniku omówione zostaną możliwe rozwiązania umożliwiające efektywną synchronizację przy jednoczesnym zachowaniu przepływów pracy w oddzielnych plikach YAML.

Koordynowanie przepływów pracy ze wspólnymi biegaczami

Dostarczone skrypty zarządzają przypisywaniem elementów uruchamiających dla przepływów pracy GitHub. Skrypt Bash rozpoczyna się od sprawdzenia, czy identyfikator biegacza jest już zapisany w pliku tymczasowym. Jeśli nie, korzysta curl do wysyłania zapytań do API GitHuba o dostępne moduły uruchamiające i jq aby przeanalizować odpowiedź JSON, wybierając pierwszego bezczynnego uczestnika i zapisując jego identyfikator. Skrypt Pythona osiąga podobną funkcjonalność, wykorzystując requests.get() metoda pobierania informacji o biegaczu z interfejsu API GitHuba. Następnie skrypt sprawdza, czy identyfikator biegacza jest już zapisany przy użyciu os.path.exists() i zapisuje go, jeśli nie.

Obydwa skrypty zapewniają, że po przypisaniu biegacza zostanie on ponownie wykorzystany w kolejnych zadaniach poprzez odniesienie do zapisanego identyfikatora biegacza. W skrypcie Pythona os.getenv() pobiera zmienne środowiskowe dla tokena i repozytorium GitHub oraz with open() służy do bezpiecznej obsługi operacji na plikach. Skrypty te pomagają koordynować wiele przepływów pracy, zapewniając, że działają one na tym samym module runner bez kodowania na stałe nazwy modułu runner, dzięki czemu są elastyczne i wydajne w zarządzaniu wykonywaniem przepływu pracy.

# A script to manage runner assignment
#!/bin/bash

# Check if a runner is already assigned
RUNNER_ID=$(cat /tmp/runner_id)

if [ -z "$RUNNER_ID" ]; then
  # No runner assigned yet, pick one and save its ID
  RUNNER_ID=$(curl -s -H "Authorization: token $GITHUB_TOKEN" \
               https://api.github.com/repos/$GITHUB_REPOSITORY/actions/runners |
               jq -r '.runners[] | select(.status=="online" and .busy==false) | .id' | head -n 1)
  echo $RUNNER_ID > /tmp/runner_id
fi

echo "Using runner $RUNNER_ID"

# Proceed with the workflow using the assigned runner

import requests
import os

# GitHub API token and repository
GITHUB_TOKEN = os.getenv('GITHUB_TOKEN')
REPO = os.getenv('GITHUB_REPOSITORY')

# Function to get an available runner
def get_runner():
    url = f"https://api.github.com/repos/{REPO}/actions/runners"
    headers = {'Authorization': f'token {GITHUB_TOKEN}'}
    response = requests.get(url, headers=headers)
    runners = response.json()['runners']
    for runner in runners:
        if runner['status'] == 'online' and not runner['busy']:
            return runner['id']
    return None

# Check if a runner is already assigned
if not os.path.exists('/tmp/runner_id'):
    runner_id = get_runner()
    with open('/tmp/runner_id', 'w') as f:
        f.write(str(runner_id))
else:
    with open('/tmp/runner_id', 'r') as f:
        runner_id = f.read()

print(f"Using runner {runner_id}")

Efektywne zarządzanie biegaczami w akcjach GitHub

W scenariuszach, w których przepływy pracy muszą działać na tym samym serwerze biegacza, który jest hostowany na własnym serwerze, kluczową kwestią jest zapewnienie dostępności modułu runner i minimalizowanie konfliktów. Korzystanie ze strategii współdzielonego biegacza, jak pokazano w poprzednich skryptach, gwarantuje, że po przypisaniu biegacza do zadania kolejne zadania będą korzystać z tego samego biegacza. Może to być szczególnie korzystne w złożonych potokach CI/CD, gdzie kluczowe znaczenie ma utrzymanie stanu lub wykorzystanie zasobów buforowanych.

Kolejnym aspektem, który należy wziąć pod uwagę, jest optymalizacja wykorzystania biegacza. Dynamicznie wybierając i przypisując biegaczy w oparciu o dostępność, organizacje mogą lepiej zarządzać swoimi zasobami. Wdrożenie takich strategii nie tylko poprawia wydajność, ale także skraca czas, jaki przepływy pracy spędzają w kolejce w oczekiwaniu na dostępnego biegacza. Podejście to można rozszerzyć na inne narzędzia i platformy CI/CD, dzięki czemu jest to wszechstronne rozwiązanie spełniające różne potrzeby w zakresie automatyzacji.

Wniosek:

Zarządzanie przepływami pracy GitHub tak, aby działały na tym samym, hostowanym przez siebie module runner, ma kluczowe znaczenie dla wydajności i spójności. Omawiane skrypty Bash i Python zapewniają solidne rozwiązanie poprzez dynamiczne przypisywanie modułów wykonawczych i zapewnienie, że kolejne zadania korzystają z tego samego modułu uruchamiającego. Takie podejście minimalizuje konflikty i optymalizuje wykorzystanie zasobów, dzięki czemu jest skuteczną strategią w przypadku złożonych potoków CI/CD. Wdrażając te metody, organizacje mogą usprawnić realizację przepływu pracy i skrócić czas oczekiwania, ostatecznie poprawiając produktywność i utrzymując płynny proces programowania.