run-gemini-cli

Übersicht

run-gemini-cli ist eine GitHub Action, die Gemini über die Gemini CLI in deinen Entwicklungsworkflow integriert. Sie fungiert sowohl als autonomer Agent für kritische routinemäßige Programmieraufgaben als auch als bedarfsorientierter Mitarbeiter, dem du schnell Aufgaben delegieren kannst.

Verwende sie, um GitHub-Pull-Request-Reviews durchzuführen, Issues zu kategorisieren, Code-Analysen und -Modifikationen vorzunehmen und vieles mehr – und das alles im Gespräch mit Gemini (z. B. @gemini-cli behebe dieses Problem) direkt in deinen GitHub-Repositorys.

• run-gemini-cli
  • Übersicht
  • Funktionen
  • Schnellstart
    • 1. Hol dir einen Gemini-API-Schlüssel
    • 2. Füge ihn als GitHub-Secret hinzu
    • 3. Aktualisiere deine .gitignore
    • 4. Wähle einen Workflow
    • 5. Probier es aus!
  • Workflows
    • Gemini Dispatch
    • Issue Triage
    • Pull-Request-Review
    • Gemini CLI Assistant
  • Konfiguration
    • Eingaben
    • Ausgaben
    • Repository-Variablen
    • Secrets
  • Authentifizierung
    • Google-Authentifizierung
    • GitHub-Authentifizierung
  • Observability
  • Erweiterungen
  • Best Practices
  • Anpassung
  • Mitwirken

Funktionen

• Automatisierung: Workflows durch Ereignisse (z. B. Öffnen eines Issues) oder Zeitpläne (z. B. nächtlich) auslösen.
• Bedarfsorientierte Zusammenarbeit: Workflows in Issue- und Pull-Request-Kommentaren durch Erwähnung der Gemini CLI auslösen (z. B. @gemini-cli /review).
• Erweiterbar mit Tools: Die Tool-Aufruffähigkeiten der Gemini-Modelle nutzen, um mit anderen CLIs wie der GitHub CLI (gh) zu interagieren.
• Anpassbar: Verwende eine GEMINI.md-Datei in deinem Repository, um projektspezifische Anweisungen und Kontext für die Gemini CLI bereitzustellen.

Schnellstart

Starte in nur wenigen Minuten mit der Gemini CLI in deinem Repository:

1. Hol dir einen Gemini-API-Schlüssel

Hole deinen API-Schlüssel von Google AI Studio mit großzügigen kostenlosen Kontingenten.

2. Füge ihn als GitHub-Secret hinzu

Speichere deinen API-Schlüssel als Secret mit dem Namen GEMINI_API_KEY in deinem Repository:

• Gehe zu Einstellungen > Secrets und Variablen > Aktionen deines Repositorys.
• Klicke auf Neues Repository-Secret.
• Name: GEMINI_API_KEY, Wert: dein API-Schlüssel.

3. Aktualisiere deine .gitignore

Füge die folgenden Einträge zu deiner .gitignore-Datei hinzu:

# gemini-cli-Einstellungen
.gemini/

# GitHub-App-Anmeldedaten
gha-creds-*.json

4. Wähle einen Workflow

Du hast zwei Möglichkeiten, einen Workflow einzurichten:

Option A: Setup-Befehl verwenden (empfohlen)

1. Starte die Gemini CLI in deinem Terminal:

   root@kitploit:~

   gemini
   

2. Gib in der Gemini CLI in deinem Terminal Folgendes ein:

   root@kitploit:~

   /setup-github
   

Option B: Workflows manuell kopieren

1. Kopiere die vorgefertigten Workflows aus dem Verzeichnis examples/workflows in das Verzeichnis .github/workflows deines Repositorys. Hinweis: Der Workflow gemini-dispatch.yml muss ebenfalls kopiert werden, da er die Ausführung der anderen Workflows auslöst.

5. Probier es aus!

Pull-Request-Review:

• Öffne einen Pull-Request in deinem Repository und warte auf die automatische Überprüfung.
• Kommentiere @gemini-cli /review in einem bestehenden Pull-Request, um eine manuelle Überprüfung auszulösen.

Issue Triage:

• Öffne ein Issue und warte auf die automatische Kategorisierung.
• Kommentiere @gemini-cli /triage in bestehenden Issues, um eine manuelle Kategorisierung auszulösen.

Allgemeine KI-Unterstützung:

• Erwähne in jedem Issue oder Pull-Request @gemini-cli, gefolgt von deiner Anfrage.
• Beispiele:
  • @gemini-cli erkläre diese Codeänderung
  • @gemini-cli schlage Verbesserungen für diese Funktion vor
  • @gemini-cli hilf mir, diesen Fehler zu debuggen
  • @gemini-cli schreibe Unit-Tests für diese Komponente

Workflows

Diese Action bietet mehrere vorgefertigte Workflows für verschiedene Anwendungsfälle. Jeder Workflow ist dafür ausgelegt, in das Verzeichnis .github/workflows deines Repositorys kopiert und nach Bedarf angepasst zu werden.

Gemini Dispatch

Dieser Workflow fungiert als zentraler Verteiler für die Gemini CLI und leitet Anfragen basierend auf dem auslösenden Ereignis und dem im Kommentar angegebenen Befehl an den entsprechenden Workflow weiter. Eine detaillierte Anleitung zur Einrichtung des Dispatch-Workflows findest du in der Dokumentation zum Gemini Dispatch-Workflow.

Issue Triage

Diese Action kann verwendet werden, um GitHub Issues automatisch oder nach einem Zeitplan zu kategorisieren. Eine detaillierte Anleitung zur Einrichtung des Issue-Triage-Systems findest du in der Dokumentation zum GitHub Issue Triage-Workflow.

Pull-Request-Review

Diese Action kann verwendet werden, um Pull-Requests automatisch zu überprüfen, wenn sie geöffnet werden. Eine detaillierte Anleitung zur Einrichtung des Pull-Request-Review-Systems findest du in der Dokumentation zum GitHub PR Review-Workflow.

Gemini CLI Assistant

Diese Art von Action kann verwendet werden, um einen allgemeinen, konversationellen Gemini-KI-Assistenten in Pull-Requests und Issues zu aktivieren, der eine Vielzahl von Aufgaben ausführen kann. Eine detaillierte Anleitung zur Einrichtung des allgemeinen Gemini CLI-Workflows findest du in der Dokumentation zum Gemini Assistant-Workflow.

Konfiguration

Eingaben

• gcp_location: (Optional) Der Google Cloud-Standort.

• gcp_project_id: (Optional) Die Google Cloud-Projekt-ID.

• gcp_service_account: (Optional) Die Google Cloud-Dienstkonto-E-Mail.

• gcp_workload_identity_provider: (Optional) Der Google Cloud Workload Identity Provider.

• gcp_token_format: (Optional, Standard: access_token) Das Token-Format für die Authentifizierung. Setze auf "access_token", um Zugriffstoken zu generieren (erfordert ein Dienstkonto), oder auf eine leere Zeichenfolge für direktes WIF. Kann "access_token" oder "id_token" sein.

• gcp_access_token_scopes: (Optional, Standard: https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/userinfo.email,https://www.googleapis.com/auth/userinfo.profile) Die Zugriffsbereiche des Zugriffstokens bei Verwendung von token_format "access_token". Kommagetrennte Liste von OAuth 2.0-Bereichen.

Ausgaben

• summary: Die zusammengefasste Ausgabe der Gemini CLI-Ausführung.

• error: Die Fehlerausgabe der Gemini CLI-Ausführung, falls vorhanden.

Repository-Variablen

Wir empfehlen, die folgenden Werte als Repository-Variablen zu setzen, damit sie in allen Workflows wiederverwendet werden können. Alternativ kannst du sie inline als Aktions-Eingaben in einzelnen Workflows setzen oder um Repository-Level-Werte zu überschreiben.

[!WARNING] Verwende nicht die Umgebungsvariable DEBUG, da dies dazu führt, dass die Gemini CLI hängt und auf den Node-Debugger wartet.

So fügst du eine Repository-Variable hinzu:

1. Gehe zu Einstellungen > Secrets und Variablen > Aktionen > Neue Variable deines Repositorys.
2. Gib den Variablennamen und -wert ein.
3. Speichern.

Details zu Repository-Variablen findest du in der GitHub-Dokumentation zu Variablen.

Secrets

Du kannst die folgenden Secrets in deinem Repository festlegen:

So fügst du ein Secret hinzu:

1. Gehe zu Einstellungen > Secrets und Variablen > Aktionen > Neues Repository-Secret deines Repositorys.
2. Gib den Secret-Namen und -Wert ein.
3. Speichern.

Weitere Informationen findest du in der offiziellen GitHub-Dokumentation zum Erstellen und Verwenden von verschlüsselten Secrets.

Authentifizierung

Diese Action erfordert eine Authentifizierung sowohl bei Google-Diensten (für Gemini AI) als auch bei der GitHub-API.

Google-Authentifizierung

Wähle die Authentifizierungsmethode, die am besten zu deinem Anwendungsfall passt:

1. Gemini-API-Schlüssel: Die einfachste Methode für Projekte, die keine Google Cloud-Integration benötigen.
2. Workload Identity Federation: Die sicherste Methode zur Authentifizierung bei Google Cloud-Diensten.

GitHub-Authentifizierung

Du kannst dich auf zwei Arten bei GitHub authentifizieren:

1. Standard GITHUB_TOKEN: Für einfachere Anwendungsfälle kann die Action das von Workflow bereitgestellte Standard-GITHUB_TOKEN verwenden.
2. Benutzerdefinierte GitHub-App (empfohlen): Für die sicherste und flexibelste Authentifizierung empfehlen wir die Erstellung einer benutzerdefinierten GitHub-App.

Detaillierte Einrichtungsanweisungen für die Google- und GitHub-Authentifizierung findest du in der Authentifizierungsdokumentation.

Observability

Diese Action kann so konfiguriert werden, dass Telemetriedaten (Traces, Metriken und Logs) an dein eigenes Google Cloud-Projekt gesendet werden. So kannst du die Leistung und das Verhalten der Gemini CLI in deinen Workflows überwachen und wertvolle Erkenntnisse für Debugging und Optimierung gewinnen.

Detaillierte Anweisungen zum Einrichten und Konfigurieren von Observability findest du in der Observability-Dokumentation.

Erweiterungen

Die Gemini CLI kann durch Erweiterungen mit zusätzlichen Funktionen erweitert werden. Diese Erweiterungen werden aus dem Quellcode von ihren GitHub-Repositorys installiert.

Detaillierte Anweisungen zum Einrichten und Konfigurieren von Erweiterungen findest du in der Erweiterungsdokumentation.

Best Practices

Um die Sicherheit, Zuverlässigkeit und Effizienz deiner automatisierten Workflows zu gewährleisten, empfehlen wir dringend, unsere Best Practices zu befolgen. Diese Richtlinien decken wichtige Bereiche wie Repository-Sicherheit, Workflow-Konfiguration und Überwachung ab.

Wichtige Empfehlungen umfassen:

• Sichern deines Repositorys: Implementieren von Branch- und Tag-Schutz sowie Einschränkung der Pull-Request-Genehmiger.
• Workflow-Konfiguration: Verwenden der Workload Identity Federation für eine sichere Authentifizierung bei Google Cloud, effektives Verwalten von Secrets und Festlegen von Aktionsversionen, um unerwartete Änderungen zu verhindern.
• Überwachung und Prüfung: Regelmäßiges Überprüfen der Aktionslogs und Aktivieren von OpenTelemetry für tiefere Einblicke in Leistung und Verhalten.

Eine umfassende Anleitung zum Sichern deines Repositorys und deiner Workflows findest du in unserer Best Practices-Dokumentation.

Anpassung

Erstelle eine GEMINI.md-Datei im Stammverzeichnis deines Repositorys, um der Gemini CLI projektspezifischen Kontext und Anweisungen bereitzustellen. Dies ist nützlich, um Codierungskonventionen, Architekturmuster oder andere Richtlinien zu definieren, denen das Modell für ein bestimmtes Repository folgen soll.

Mitwirken

Beiträge sind willkommen! Weitere Informationen zum Einstieg findest du im Mitwirkungsleitfaden der Gemini CLI.