run-gemini-cli

Panoramica

run-gemini-cli è una GitHub Action che integra Gemini nel tuo flusso di sviluppo tramite la Gemini CLI. Funge sia da agente autonomo per attività di codifica di routine critiche, sia da collaboratore su richiesta a cui puoi delegare rapidamente del lavoro.

Usalo per eseguire revisioni delle pull request su GitHub, triage degli issue, analisi e modifica del codice e altro ancora utilizzando Gemini in modo conversazionale (ad es., @gemini-cli risolvi questo problema) direttamente all'interno dei tuoi repository GitHub.

• run-gemini-cli
  • Panoramica
  • Funzionalità
  • Guida rapida
    • 1. Ottieni una chiave API Gemini
    • 2. Aggiungila come Segreto GitHub
    • 3. Aggiorna il tuo .gitignore
    • 4. Scegli un Flusso di Lavoro
    • 5. Provalo!
  • Flussi di Lavoro
    • Gemini Dispatch
    • Triage degli Issue
    • Revisione delle Pull Request
    • Assistente Gemini CLI
  • Configurazione
    • Input
    • Output
    • Variabili del Repository
    • Segreti
  • Autenticazione
    • Autenticazione Google
    • Autenticazione GitHub
  • Osservabilità
  • Estensioni
  • Buone Pratiche
  • Personalizzazione
  • Contribuire

Funzionalità

• Automazione: Attiva flussi di lavoro basati su eventi (es. apertura di un issue) o su pianificazioni (es. notturno).
• Collaborazione su richiesta: Attiva flussi di lavoro in issue e commenti delle pull request menzionando la Gemini CLI (es., @gemini-cli /review).
• Estendibile con Strumenti: Sfrutta le capacità di chiamata agli strumenti dei modelli Gemini per interagire con altre CLI come la GitHub CLI (gh).
• Personalizzabile: Usa un file GEMINI.md nel tuo repository per fornire istruzioni e contesto specifici del progetto alla Gemini CLI.

Guida rapida

Inizia con la Gemini CLI nel tuo repository in pochi minuti:

1. Ottieni una chiave API Gemini

Ottieni la tua chiave API da Google AI Studio con generose quote gratuite

2. Aggiungila come Segreto GitHub

Salva la tua chiave API come segreto denominato GEMINI_API_KEY nel tuo repository:

• Vai a Settings > Secrets and variables > Actions del tuo repository
• Clicca su New repository secret
• Nome: GEMINI_API_KEY, Valore: la tua chiave API

3. Aggiorna il tuo .gitignore

Aggiungi le seguenti voci al tuo file .gitignore:

# impostazioni gemini-cli
.gemini/

# credenziali GitHub App
gha-creds-*.json

4. Scegli un Flusso di Lavoro

Hai due opzioni per impostare un flusso di lavoro:

Opzione A: Usa il comando di configurazione (Consigliata)

1. Avvia la Gemini CLI nel tuo terminale:

   root@kitploit:~

   gemini
   

2. Nella Gemini CLI nel tuo terminale, scrivi:

   root@kitploit:~

   /setup-github
   

Opzione B: Copia manualmente i flussi di lavoro

1. Copia i flussi di lavoro predefiniti dalla directory examples/workflows nella directory .github/workflows del tuo repository. Nota: anche il flusso di lavoro gemini-dispatch.yml deve essere copiato, poiché attiva l'esecuzione degli altri flussi di lavoro.

5. Provalo!

Revisione delle Pull Request:

• Apri una pull request nel tuo repository e attendi la revisione automatica
• Commenta @gemini-cli /review su una pull request esistente per attivare manualmente una revisione

Triage degli Issue:

• Apri un issue e attendi il triage automatico
• Commenta @gemini-cli /triage su issue esistenti per attivare manualmente il triage

Assistenza AI Generale:

• In qualsiasi issue o pull request, menziona @gemini-cli seguito dalla tua richiesta
• Esempi:
  • @gemini-cli spiega questa modifica al codice
  • @gemini-cli suggerisci miglioramenti per questa funzione
  • @gemini-cli aiutami a debuggare questo errore
  • @gemini-cli scrivi unit test per questo componente

Flussi di Lavoro

Questa azione fornisce diversi flussi di lavoro predefiniti per diversi casi d'uso. Ogni flusso di lavoro è progettato per essere copiato nella directory .github/workflows del tuo repository e personalizzato secondo necessità.

Gemini Dispatch

Questo flusso di lavoro funge da dispatcher centrale per la Gemini CLI, instradando le richieste al flusso di lavoro appropriato in base all'evento scatenante e al comando fornito nel commento. Per una guida dettagliata su come configurare il flusso di lavoro di dispatch, vai alla documentazione del flusso di lavoro Gemini Dispatch.

Triage degli Issue

Questa azione può essere utilizzata per eseguire il triage degli Issue GitHub automaticamente o secondo una pianificazione. Per una guida dettagliata su come impostare il sistema di triage degli issue, vai alla documentazione del flusso di lavoro Triage degli Issue.

Revisione delle Pull Request

Questa azione può essere utilizzata per revisionare automaticamente le pull request quando vengono aperte. Per una guida dettagliata su come impostare il sistema di revisione delle pull request, vai alla documentazione del flusso di lavoro Revisione PR.

Assistente Gemini CLI

Questo tipo di azione può essere utilizzato per invocare un assistente AI conversazionale generico di Gemini all'interno delle pull request e degli issue per svolgere un'ampia gamma di compiti. Per una guida dettagliata su come configurare il flusso di lavoro generico della Gemini CLI, vai alla documentazione del flusso di lavoro Assistente Gemini.

Configurazione

Input

• gcp_location: (Opzionale) La località di Google Cloud.

• gcp_project_id: (Opzionale) L'ID del progetto Google Cloud.

• gcp_service_account: (Opzionale) L'email dell'account di servizio Google Cloud.

• gcp_workload_identity_provider: (Opzionale) Il Provider di Identità del Carico di Lavoro Google Cloud.

• gcp_token_format: (Opzionale, default: access_token) Il formato del token per l'autenticazione. Imposta su "access_token" per generare token di accesso (richiede un account di servizio), o lascia vuoto per WIF diretto. Può essere "access_token" o "id_token".

• gcp_access_token_scopes: (Opzionale, default: https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/userinfo.email,https://www.googleapis.com/auth/userinfo.profile) Gli ambiti del token di accesso quando si usa token_format "access_token". Elenco separato da virgole di ambiti OAuth 2.0.

Output

• summary: L'output riassuntivo dell'esecuzione della Gemini CLI.

• error: L'output di errore dell'esecuzione della Gemini CLI, se presente.

Variabili del Repository

Consigliamo di impostare i seguenti valori come variabili del repository in modo che possano essere riutilizzate in tutti i flussi di lavoro. In alternativa, puoi impostarli direttamente come input dell'azione in singoli flussi di lavoro o per sovrascrivere i valori a livello di repository.

[!WARNING] Non utilizzare la variabile d'ambiente DEBUG poiché causa il blocco della Gemini CLI in attesa del collegamento del debugger di Node.

Per aggiungere una variabile del repository:

1. Vai a Settings > Secrets and variables > Actions > New variable del tuo repository.
2. Inserisci il nome e il valore della variabile.
3. Salva.

Per dettagli sulle variabili del repository, consulta la documentazione GitHub sulle variabili.

Segreti

Puoi impostare i seguenti segreti nel tuo repository:

Per aggiungere un segreto:

1. Vai a Settings > Secrets and variables > Actions > New repository secret del tuo repository.
2. Inserisci il nome e il valore del segreto.
3. Salva.

Per maggiori informazioni, consulta la documentazione ufficiale GitHub sulla creazione e l'uso di segreti crittografati.

Autenticazione

Questa azione richiede l'autenticazione sia per i servizi Google (per Gemini AI) che per l'API GitHub.

Autenticazione Google

Scegli il metodo di autenticazione che meglio si adatta al tuo caso d'uso:

1. Chiave API Gemini: Il metodo più semplice per progetti che non richiedono l'integrazione con Google Cloud
2. Federazione delle Identità del Carico di Lavoro: Il metodo più sicuro per autenticarsi ai servizi Google Cloud

Autenticazione GitHub

Puoi autenticarti con GitHub in due modi:

1. GITHUB_TOKEN predefinito: Per casi d'uso più semplici, l'azione può utilizzare il GITHUB_TOKEN predefinito fornito dal flusso di lavoro.
2. App GitHub personalizzata (Consigliato): Per l'autenticazione più sicura e flessibile, consigliamo di creare un'App GitHub personalizzata.

Per istruzioni dettagliate su come impostare l'autenticazione Google e GitHub, vai alla documentazione sull'Autenticazione.

Osservabilità

Questa azione può essere configurata per inviare dati di telemetria (tracce, metriche e log) al tuo progetto Google Cloud. Questo ti permette di monitorare le prestazioni e il comportamento della Gemini CLI all'interno dei tuoi flussi di lavoro, fornendo preziose informazioni per il debug e l'ottimizzazione.

Per istruzioni dettagliate su come impostare e configurare l'osservabilità, vai alla documentazione sull'Osservabilità.

Estensioni

La Gemini CLI può essere estesa con funzionalità aggiuntive tramite estensioni. Queste estensioni vengono installate dal codice sorgente dai loro repository GitHub.

Per istruzioni dettagliate su come impostare e configurare le estensioni, vai alla documentazione sulle Estensioni.

Buone Pratiche

Per garantire la sicurezza, l'affidabilità e l'efficienza dei tuoi flussi di lavoro automatizzati, consigliamo vivamente di seguire le nostre buone pratiche. Queste linee guida coprono aree chiave come la sicurezza del repository, la configurazione del flusso di lavoro e il monitoraggio.

Raccomandazioni chiave includono:

• Proteggere il tuo Repository: Implementare la protezione di branch e tag e limitare gli approvatori delle pull request.
• Configurazione del Flusso di Lavoro: Utilizzare la Federazione delle Identità del Carico di Lavoro per un'autenticazione sicura a Google Cloud, gestire efficacemente i segreti e bloccare le versioni delle azioni per prevenire cambiamenti imprevisti.
• Monitoraggio e Audit: Revisionare regolarmente i log delle azioni e abilitare OpenTelemetry per approfondimenti più approfonditi sulle prestazioni e il comportamento.

Per una guida completa sulla protezione del tuo repository e dei flussi di lavoro, consulta la nostra documentazione sulle Buone Pratiche.

Personalizzazione

Crea un file GEMINI.md nella radice del tuo repository per fornire contesto e istruzioni specifici del progetto a Gemini CLI. Questo è utile per definire convenzioni di codifica, pattern architetturali o altre linee guida che il modello dovrebbe seguire per un dato repository.

Contribuire

I contributi sono i benvenuti! Consulta la Guida ai Contributi della Gemini CLI per maggiori dettagli su come iniziare.