run-gemini-cli

Aperçu

run-gemini-cli est une action GitHub qui intègre Gemini dans votre flux de développement via le Gemini CLI. Elle agit à la fois comme un agent autonome pour les tâches de codage critiques et récurrentes, et comme un collaborateur à la demande auquel vous pouvez rapidement déléguer du travail.

Utilisez-la pour effectuer des revues de pull request GitHub, trier les issues, réaliser des analyses et modifications de code, et plus encore en utilisant Gemini de manière conversationnelle (par exemple, @gemini-cli fix this issue) directement dans vos dépôts GitHub.

• run-gemini-cli
  • Aperçu
  • Fonctionnalités
  • Démarrage rapide
    • 1. Obtenir une clé API Gemini
    • 2. L'ajouter en tant que secret GitHub
    • 3. Mettre à jour votre .gitignore
    • 4. Choisir un workflow
    • 5. Essayez-le !
  • Workflows
    • Gemini Dispatch
    • Tri d'issues
    • Revue de Pull Request
    • Assistant Gemini CLI
  • Configuration
    • Entrées
    • Sorties
    • Variables de dépôt
    • Secrets
  • Authentification
    • Authentification Google
    • Authentification GitHub
  • Observabilité
  • Extensions
  • Bonnes pratiques
  • Personnalisation
  • Contribuer

Fonctionnalités

• Automatisation : Déclencher des workflows en fonction d'événements (par ex. ouverture d'une issue) ou de plannings (par ex. nocturne).
• Collaboration à la demande : Déclencher des workflows dans les commentaires d'issues et de pull requests en mentionnant le Gemini CLI (par ex., @gemini-cli /review).
• Extensible avec des outils : Exploiter les capacités d'appel d'outils des modèles Gemini pour interagir avec d'autres CLI comme le GitHub CLI (gh).
• Personnalisable : Utiliser un fichier GEMINI.md dans votre dépôt pour fournir des instructions et un contexte spécifiques au projet au Gemini CLI.

Démarrage rapide

Commencez à utiliser Gemini CLI dans votre dépôt en quelques minutes :

1. Obtenir une clé API Gemini

Obtenez votre clé API depuis Google AI Studio avec des quotas généreux gratuits

2. L'ajouter en tant que secret GitHub

Stockez votre clé API en tant que secret nommé GEMINI_API_KEY dans votre dépôt :

• Allez dans Settings > Secrets and variables > Actions de votre dépôt
• Cliquez sur New repository secret
• Nom : GEMINI_API_KEY, Valeur : votre clé API

3. Mettre à jour votre .gitignore

Ajoutez les entrées suivantes à votre fichier .gitignore :

# gemini-cli settings
.gemini/

# GitHub App credentials
gha-creds-*.json

4. Choisir un workflow

Vous avez deux options pour configurer un workflow :

Option A : Utiliser la commande de configuration (Recommandé)

1. Lancez le Gemini CLI dans votre terminal :

   root@kitploit:~

   gemini
   

2. Dans le Gemini CLI dans votre terminal, tapez :

   root@kitploit:~

   /setup-github
   

Option B : Copier manuellement les workflows

1. Copiez les workflows préconstruits du répertoire examples/workflows vers le répertoire .github/workflows de votre dépôt. Remarque : le workflow gemini-dispatch.yml doit également être copié, car il déclenche l'exécution des workflows.

5. Essayez-le !

Revue de Pull Request :

• Ouvrez une pull request dans votre dépôt et attendez la revue automatique
• Commentez @gemini-cli /review sur une pull request existante pour déclencher manuellement une revue

Tri d'issues :

• Ouvrez une issue et attendez le tri automatique
• Commentez @gemini-cli /triage sur des issues existantes pour déclencher manuellement le tri

Assistance IA générale :

• Dans toute issue ou pull request, mentionnez @gemini-cli suivi de votre demande
• Exemples :
  • @gemini-cli explain this code change
  • @gemini-cli suggest improvements for this function
  • @gemini-cli help me debug this error
  • @gemini-cli write unit tests for this component

Workflows

Cette action fournit plusieurs workflows préconstruits pour différents cas d'utilisation. Chaque workflow est conçu pour être copié dans le répertoire .github/workflows de votre dépôt et personnalisé selon les besoins.

Gemini Dispatch

Ce workflow agit comme un répartiteur central pour Gemini CLI, en aiguillant les requêtes vers le workflow approprié en fonction de l'événement déclencheur et de la commande fournie dans le commentaire. Pour un guide détaillé sur la configuration du workflow de répartition, consultez la documentation du workflow Gemini Dispatch.

Tri d'issues

Cette action peut être utilisée pour trier automatiquement les issues GitHub ou selon un planning. Pour un guide détaillé sur la configuration du système de tri des issues, consultez la documentation du workflow de tri d'issues GitHub.

Revue de Pull Request

Cette action peut être utilisée pour examiner automatiquement les pull requests lorsqu'elles sont ouvertes. Pour un guide détaillé sur la configuration du système de revue des pull requests, consultez la documentation du workflow de revue de PR GitHub.

Assistant Gemini CLI

Ce type d'action peut être utilisé pour invoquer un assistant IA Gemini conversationnel et polyvalent dans les pull requests et les issues afin d'effectuer un large éventail de tâches. Pour un guide détaillé sur la configuration du workflow Gemini CLI généraliste, consultez la documentation du workflow Assistant Gemini.

Configuration

Entrées

• gcp_location: (Optionnel) L'emplacement Google Cloud.

• gcp_project_id: (Optionnel) L'ID du projet Google Cloud.

• gcp_service_account: (Optionnel) L'email du compte de service Google Cloud.

• gcp_workload_identity_provider: (Optionnel) Le fournisseur d'identité de charge de travail Google Cloud.

• gcp_token_format: (Optionnel, défaut : access_token) Le format du jeton pour l'authentification. Définissez sur "access_token" pour générer des jetons d'accès (nécessite un compte de service), ou sur une chaîne vide pour une fédération d'identité directe. Peut être "access_token" ou "id_token".

• gcp_access_token_scopes: (Optionnel, défaut : https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/userinfo.email,https://www.googleapis.com/auth/userinfo.profile) Les portées du jeton d'accès lors de l'utilisation de token_format "access_token". Liste séparée par des virgules des portées OAuth 2.0.

Sorties

• summary: La sortie résumée de l'exécution du Gemini CLI.

• error: La sortie d'erreur de l'exécution du Gemini CLI, le cas échéant.

Variables de dépôt

Nous recommandons de définir les valeurs suivantes en tant que variables de dépôt afin qu'elles puissent être réutilisées dans tous les workflows. Vous pouvez également les définir en ligne en tant qu'entrées d'action dans des workflows individuels ou pour écraser les valeurs au niveau du dépôt.

[!WARNING] N'utilisez pas la variable d'environnement DEBUG car cela provoque le blocage du Gemini CLI en attente de l'attachement du débogueur node.

Pour ajouter une variable de dépôt :

1. Allez dans Settings > Secrets and variables > Actions > New variable de votre dépôt.
2. Saisissez le nom et la valeur de la variable.
3. Enregistrez.

Pour plus de détails sur les variables de dépôt, consultez la documentation GitHub sur les variables.

Secrets

Vous pouvez définir les secrets suivants dans votre dépôt :

Pour ajouter un secret :

1. Allez dans Settings > Secrets and variables > Actions > New repository secret de votre dépôt.
2. Saisissez le nom et la valeur du secret.
3. Enregistrez.

Pour plus d'informations, consultez la documentation officielle GitHub sur la création et l'utilisation de secrets chiffrés.

Authentification

Cette action nécessite une authentification auprès des services Google (pour Gemini AI) et de l'API GitHub.

Authentification Google

Choisissez la méthode d'authentification qui correspond le mieux à votre cas d'utilisation :

1. Clé API Gemini : La méthode la plus simple pour les projets qui ne nécessitent pas d'intégration Google Cloud
2. Fédération d'identité de charge de travail : La méthode la plus sécurisée pour s'authentifier aux services Google Cloud

Authentification GitHub

Vous pouvez vous authentifier auprès de GitHub de deux manières :

1. GITHUB_TOKEN par défaut : Pour les cas d'utilisation plus simples, l'action peut utiliser le GITHUB_TOKEN par défaut fourni par le workflow.
2. Application GitHub personnalisée (Recommandé) : Pour l'authentification la plus sécurisée et flexible, nous recommandons de créer une application GitHub personnalisée.

Pour des instructions détaillées de configuration pour l'authentification Google et GitHub, consultez la documentation d'authentification.

Observabilité

Cette action peut être configurée pour envoyer des données de télémétrie (traces, métriques et logs) vers votre propre projet Google Cloud. Cela vous permet de surveiller les performances et le comportement du Gemini CLI dans vos workflows, fournissant des informations précieuses pour le débogage et l'optimisation.

Pour des instructions détaillées sur la configuration de l'observabilité, consultez la documentation d'observabilité.

Extensions

Le Gemini CLI peut être étendu avec des fonctionnalités supplémentaires via des extensions. Ces extensions sont installées depuis leur source depuis leurs dépôts GitHub.

Pour des instructions détaillées sur la configuration des extensions, consultez la documentation des extensions.

Bonnes pratiques

Pour garantir la sécurité, la fiabilité et l'efficacité de vos workflows automatisés, nous vous recommandons vivement de suivre nos bonnes pratiques. Ces directives couvrent des domaines clés tels que la sécurité du dépôt, la configuration du workflow et la surveillance.

Les principales recommandations incluent :

• Sécuriser votre dépôt : Mettre en place une protection des branches et des tags, et restreindre les approbateurs de pull requests.
• Configuration du workflow : Utiliser la fédération d'identité de charge de travail pour une authentification sécurisée à Google Cloud, gérer efficacement les secrets, et épingler les versions d'action pour éviter les changements inattendus.
• Surveillance et audit : Examiner régulièrement les logs d'action et activer OpenTelemetry pour des informations plus approfondies sur les performances et le comportement.

Pour un guide complet sur la sécurisation de votre dépôt et de vos workflows, veuillez consulter notre documentation des bonnes pratiques.

Personnalisation

Créez un fichier GEMINI.md à la racine de votre dépôt pour fournir un contexte et des instructions spécifiques au projet au Gemini CLI. Cela est utile pour définir des conventions de codage, des modèles architecturaux ou d'autres directives que le modèle doit suivre pour un dépôt donné.

Contribuer

Les contributions sont les bienvenues ! Consultez le Guide de contribution du Gemini CLI pour plus de détails sur la façon de commencer.