Verwenden von Copilot CLI in GitHub Actions mit GITHUB_TOKEN

Informationen zu Authentifizierungsoptionen und dazu, wie die Abrechnung funktioniert, wenn Copilot CLI in GitHub Actions ausgeführt wird, finden Sie unter Informationen zur Verwendung von Copilot CLI in GitHub Actions.

Aktivieren der Richtlinie

Damit Workflows in Ihrer Organisation Copilot CLI mit GITHUB_TOKEN verwenden können, muss die Richtlinie aktiviert sein. Diese Richtlinie ist standardmäßig für Organisationen aktiviert, die Copilot CLI aktiviert sind, aber Sie können diese Einstellung in den Richtlinieneinstellungen Ihrer Organisation bestätigen oder ändern.

1. Navigieren Sie zu den Richtlinieneinstellungen für Ihre Organisation. Siehe Verwalten von Richtlinien und Features für GitHub Copilot in Ihrer Organisation.
2. Bestätigen Sie unter „Copilot CLI“, dass Verwendung von Copilot CLI, die der Organisation in Rechnung gestellt wird ausgewählt ist.

Empfohlener Ansatz: GitHub Agentic Workflows

Für die meisten Automatisierungsfälle empfehlen wir, agentische Workflows zu verwendenGitHub, anstatt direkt in Workflowschritten copilot aufzurufen. Agentische Arbeitsabläufe verwenden standardmäßig die GITHUB_TOKEN-Authentifizierung und umfassen zusätzliche Sicherheitsvorkehrungen, die auf automatisierte Umgebungen zugeschnitten sind.

Anweisungen zum Einrichten finden Sie in der Dokumentation zu agentischen Workflows unter GitHub". Ihr Workflow muss auch über die Berechtigung copilot-requests: write verfügen. Siehe Berechtigungen in der GitHub Dokumentation zu agentischen Workflows.

Direkte Verwendung von Copilot CLI in einem Workflow

Wenn Sie direkt in einem Workflowschritt aufrufen Copilot CLI müssen, installieren Sie die CLI mit npm.

Beispielworkflow

name: Copilot CLI example
on: [push]

permissions:
  contents: read
  copilot-requests: write

jobs:
  copilot:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 2
      - name: Install Copilot CLI
        run: npm install -g @github/copilot
      - name: Run Copilot
        run: copilot -p "Use git show HEAD to summarize the changes in this commit" -s --allow-tool='shell(git show:*)'
        env:
          GITHUB_TOKEN: ${{ github.token }}

Wichtige Details zu diesem Beispiel:

• Die Option fetch-depth: 2 ruft den aktuellen Commit und seinen Parent-Commit ab, sodass git show HEAD die durch den aktuellen Commit eingeführten Änderungen berechnen kann.
• Die --allow-tool='shell(git show:*)'-Option ermöglicht Copilot CLI, git show-Befehle auszuführen, ohne eine Genehmigung anzufordern. Nicht interaktive (-p) Ausführungen können keine interaktive Genehmigungsaufforderung anzeigen, sodass jede Aktion, die nicht vorab genehmigt wurde, automatisch verweigert wird.
• Die copilot-requests: write Berechtigung ist erforderlich, damit der Workflow Copilot-Anfragen senden kann.
• Die von GitHub Actions bereitgestellte GITHUB_TOKEN übernimmt die Authentifizierung automatisch. Es sind keine weiteren geheimen Schlüssel erforderlich.