Leitfaden: Git-Workflows auf demselben Runner ausführen

Koordinieren von GitHub-Workflows auf Shared Runnern

Das Verwalten mehrerer Workflows in GitHub Actions kann eine Herausforderung sein, insbesondere wenn sie auf demselben selbstgehosteten Läufer ausgeführt werden müssen. In Szenarien, in denen Sie separate YAML-Dateien für verschiedene Workflows haben, wie etwa codeql.yml und snyk-zap.yml, kann es schwierig sein, sicherzustellen, dass sie auf demselben Runner aus einer bestimmten Gruppe ausgeführt werden.

Das Ziel besteht darin, denselben Runner für beide Workflows zu verwenden, ohne den Runner explizit zu benennen, um so Konflikte mit anderen Workflows zu vermeiden. In diesem Leitfaden werden mögliche Lösungen untersucht, um diese Synchronisierung effizient zu erreichen und gleichzeitig die Arbeitsabläufe in separaten YAML-Dateien beizubehalten.

Koordinieren von Arbeitsabläufen mit Shared Runnern

Die bereitgestellten Skripte verwalten die Läuferzuweisung für GitHub-Workflows. Das Bash-Skript prüft zunächst, ob eine Runner-ID bereits in einer temporären Datei gespeichert ist. Wenn nicht, wird es verwendet curl um die API von GitHub nach verfügbaren Läufern abzufragen und jq Um die JSON-Antwort zu analysieren, wählen Sie den ersten inaktiven Läufer aus und speichern Sie seine ID. Das Python-Skript erreicht eine ähnliche Funktionalität durch die Verwendung von requests.get() Methode zum Abrufen von Runner-Informationen von der GitHub-API. Das Skript prüft dann, ob bereits eine Läufer-ID hinterlegt ist os.path.exists() und speichert es, wenn nicht.

Beide Skripte stellen sicher, dass ein einmal zugewiesener Runner für nachfolgende Jobs wiederverwendet wird, indem sie auf die gespeicherte Runner-ID verweisen. Im Python-Skript os.getenv() ruft Umgebungsvariablen für das GitHub-Token und das GitHub-Repository ab und with open() wird verwendet, um Dateioperationen sicher abzuwickeln. Diese Skripte helfen bei der Koordinierung mehrerer Workflows und stellen sicher, dass sie auf demselben Runner ausgeführt werden, ohne dass der Runner-Name fest codiert wird. Dadurch sind sie bei der Verwaltung der Workflow-Ausführung flexibel und effizient.

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

Effizientes Runner-Management in GitHub-Aktionen

In Szenarien, in denen Workflows auf demselben selbstgehosteten Läufer ausgeführt werden müssen, ist die Sicherstellung der Läuferverfügbarkeit und die Minimierung von Konflikten ein wichtiger Aspekt. Durch die Verwendung einer Shared-Runner-Strategie, wie in den vorherigen Skripten gezeigt, wird sichergestellt, dass, sobald ein Runner einem Job zugewiesen wurde, nachfolgende Jobs denselben Runner verwenden. Dies kann besonders in komplexen CI/CD-Pipelines von Vorteil sein, bei denen die Aufrechterhaltung des Status oder die Nutzung zwischengespeicherter Ressourcen von entscheidender Bedeutung ist.

Ein weiterer zu berücksichtigender Aspekt ist die Optimierung der Läuferauslastung. Durch die dynamische Auswahl und Zuweisung von Läufern basierend auf der Verfügbarkeit können Unternehmen ihre Ressourcen besser verwalten. Die Implementierung solcher Strategien verbessert nicht nur die Effizienz, sondern reduziert auch die Zeit, die Workflows in der Warteschlange verbringen und auf einen verfügbaren Läufer warten. Dieser Ansatz kann auf andere CI/CD-Tools und Plattformen erweitert werden, was ihn zu einer vielseitigen Lösung für verschiedene Automatisierungsanforderungen macht.

Abschluss:

Die Verwaltung von GitHub-Workflows zur Ausführung auf demselben selbstgehosteten Läufer ist für Effizienz und Konsistenz von entscheidender Bedeutung. Die besprochenen Bash- und Python-Skripte bieten eine robuste Lösung, indem sie Läufer dynamisch zuweisen und sicherstellen, dass nachfolgende Jobs denselben Läufer verwenden. Dieser Ansatz minimiert Konflikte und optimiert die Ressourcennutzung, was ihn zu einer effektiven Strategie für komplexe CI/CD-Pipelines macht. Durch die Implementierung dieser Methoden können Unternehmen ihre Workflow-Ausführung optimieren und Wartezeiten verkürzen, was letztlich die Produktivität steigert und einen reibungslosen Entwicklungsprozess gewährleistet.