Entwickeln agentischer Workflows in GitHub Actions

Verwenden Sie diese Option GitHub agentenbasierte Workflows , um Markdown-Anweisungen in Automatisierungen umzuwandeln, die von Codierungs-Agents von Drittanbietern unterstützt werden.

In diesem Artikel

Hinweis

GitHub agentenbasierte Workflows sind in Öffentliche Vorschau und können geändert werden.

Einführung

GitHub agentenbasierte Workflows Sie können Repositoryautomatisierungen in Markdown definieren und den KI-Codierungs-Agent auswählen, der sie ausführt. Die gh aw Erweiterung kompiliert jeden agentischen Workflow in einen GitHub Actions Workflow.

Der gesamte Workflowlebenszyklus – Erstellen, Debuggen und Optimierung – ist selbst agentisch. Sie beschreiben, was Sie in natürlicher Sprache wünschen, und ein Codierungs-Agent erstellt, verfeinert und problembehandlungen den Workflow für Sie.

In diesem Lernprogramm wird ein Codierungs-Agent verwendet, um einen automatisierten Pull-Anforderungsprüfer zu erstellen, der überprüft, ob Änderungen angemessen getestet werden.

Voraussetzungen

Bevor Sie beginnen, sollten Sie sicherstellen, dass Sie über Folgendes verfügen:

  • Ein Repository, in dem GitHub Actions aktiviert ist und Sie Schreibzugriff haben
  • GitHub CLI Version 2.0.0 oder höher installiert und authentifiziert
  • Zugriff auf einen unterstützten Codierungs-Agent, z Claude Code, OpenAI Codexoder Google Gemini CLI. B. oder Copilot CLI, und seine erforderlichen Anmeldeinformationen

Führen Sie folgendes aus, um sich zu authentifizieren GitHub CLI:

gh auth login --scopes repo,workflow

Installieren der gh aw Erweiterung

Installieren Sie die GitHub agentenbasierte Workflows Erweiterung für GitHub CLI:

gh extension install github/gh-aw

Auswählen eines Agents und Konfigurieren der Authentifizierung

Wählen Sie die Agent-CLI aus, die am besten zu Ihrem Workflow passt. Claude Code, OpenAI Codexoder Google Gemini CLI, und Copilot CLI kann alle ausgeführt werden GitHub agentenbasierte Workflows.

In diesem Artikel wird ein einfaches Setup erläutert, das die Anmeldeinformationen des Agents als Repositoryschlüssel hinzufügt. Wenn Sie den API-Schlüssel des Agents verwenden Claude Code, OpenAI Codexoder Google Gemini CLI, speichern Sie den API-Schlüssel des Agents als Repositoryschlüssel.

| Agent CLI | engine Wert | Repositorygeheimnis | | --- | --- | --- | | Claude Code | claude | ANTHROPIC_API_KEYenthält einen Anthropic-API-Schlüssel | | OpenAI Codex | codex | OPENAI_API_KEY enthält einen OpenAI-API-Schlüssel | | Google Gemini CLI | gemini | GEMINI_API_KEY enthält einen Google AI Studio-API-Schlüssel | | Copilot CLI (Standardwert) | copilot | Kein geheimer Schlüssel für Organisationsrepositorys erforderlich (siehe unten). Bei persönlichen Repositorys, COPILOT_GITHUB_TOKEN die mit Copilot Anforderungen auf "Lesen" abgestimmt sindpersonal access token. |

Andere Motoren wie Pi (experimentell) werden ebenfalls unterstützt. Die vollständige Liste finden Sie in der GitHub agentenbasierte Workflows Authentifizierungsreferenz.

Organisationsabrechnung für GitHub Copilot

Wenn Sie in einem organisationseigenen Repository verwenden GitHub CopilotGitHub Actions, können Sie anstelle GITHUB_TOKEN eines personal access token. Fügen Sie copilot-requests: write Ihrem Workflow-Frontmatter permissions hinzu, und es ist kein separater Geheimschlüssel erforderlich. Die Einrichtungsschritte finden Sie unter Erstellen von agentenbasierten GitHub-Workflows.

Speichern eines geheimen Schlüssels in der benutzeroberfläche GitHub

So fügen Sie einen geheimen Schlüssel für Claude Code, OpenAI Codexoder Google Gemini CLIoder GitHub Copilot persönliche Repositorys hinzu:

  1. Navigieren Sie auf GitHub, zu Ihrem Repository.
  2. Klicken Sie unter Ihrem Repositorynamen auf "Einstellungen".
  3. Klicken Sie in der Randleiste auf "Geheime Schlüssel" und "Variablen", und klicken Sie dann auf "Aktionen".
  4. Klicke auf Neues Repositorygeheimnis.
  5. Geben Sie im Feld "Name " den geheimen Namen aus der obigen Tabelle ein.
  6. Geben Sie im Feld "Geheim" den Wert ein.
  7. Klicke auf Geheimnis hinzufügen.

Erstellen des Workflows

Verwenden Sie einen Codierungs-Agent, um den Workflow aus einer Beschreibung natürlicher Sprache zu erstellen.

  1. Initialisieren Sie im Repositorystamm das Repository für die agentische Dokumenterstellung. Dadurch werden Fähigkeiten und Anweisungen hinzugefügt, die dem Codierungs-Agent beim Erstellen und Bearbeiten von Workflows helfen:

    gh aw init

  2. Starten Sie eine Codierungs-Agent-Sitzung im Kontext Ihres Repositorys, z. B. mithilfe Claude Code, OpenAI Codexoder Google Gemini CLIdes Agentmodus Copilot CLIvon VS-Code.

  3. Verwenden Sie die Fähigkeiten, und beschreiben Sie den agentic-workflows gewünschten Workflow:

    Copilot prompt
    /agentic-workflows create a pr reviewer that ensure the changes are tested.

    Der Agent erstellt eine Workflow-Markdown-Datei in .github/workflows/, kompiliert die entsprechende .lock.ymlGitHub Actions Workflowdatei und fordert Sie auf, beide Dateien zu überprüfen und zu übernehmen.

  4. Überprüfen Sie den generierten Workflow, und bitten Sie den Agent, die Dateien zu übernehmen und zu übertragen.

Tipp

Sie können den gleichen agentischen Ansatz verwenden, um den Workflow nach der Ausführung zu aktualisieren und zu verbessern. Bitten Sie den Agent, die Überprüfungskriterien zu verfeinern, weitere Prüfungen hinzuzufügen oder eine fehlgeschlagene Ausführung zu debuggen – alles in natürlicher Sprache. Wenn Sie den Workflow-Frontmatter später bearbeiten, führen Sie die Ausführung gh aw compile aus, bevor Sie die Änderungen übernehmen.

Ausführen des Workflows

Der generierte Workflow löst automatisch bei Pullanforderungen aus, sodass er ausgeführt wird, wenn Sie eine Pullanforderung im Repository das nächste Mal öffnen oder aktualisieren.

  1. Öffnen Sie eine Pull-Anforderung in Ihrem Repository.
  2. Navigieren Sie auf GitHubdem Bildschirm zu Ihrem Repository, und klicken Sie auf die Registerkarte "Aktionen ".
  3. Wählen Sie in der linken Randleiste den Workflow aus, den der Agent erstellt hat.
  4. Nach Abschluss der Ausführung verlässt der Workflow eine Pullanforderungsüberprüfung, in der angegeben wird, ob die Änderungen genügend Tests enthalten.

Nächste Schritte