run-gemini-cli

Resumen

run-gemini-cli es una acción de GitHub que integra Gemini en tu flujo de trabajo de desarrollo mediante la [CLI de Gemini]. Actúa tanto como un agente autónomo para tareas rutinarias de codificación críticas, como un colaborador bajo demanda al que puedes delegar trabajo rápidamente.

Úsala para realizar revisiones de pull requests de GitHub, clasificar issues, analizar y modificar código, y más usando Gemini de manera conversacional (p. ej., @gemini-cli arregla este issue) directamente dentro de tus repositorios de GitHub.

• run-gemini-cli
  • Resumen
  • Características
  • Inicio Rápido
    • 1. Obtén una clave de API de Gemini
    • 2. Agrégala como secreto de GitHub
    • 3. Actualiza tu .gitignore
    • 4. Elige un flujo de trabajo
    • 5. ¡Pruébalo!
  • Flujos de trabajo
    • Dispatch de Gemini
    • Clasificación de Issues
    • Revisión de Pull Requests
    • Asistente CLI de Gemini
  • Configuración
    • Entradas
    • Salidas
    • Variables de repositorio
    • Secretos
  • Autenticación
    • Autenticación de Google
    • Autenticación de GitHub
  • Observabilidad
  • Extensiones
  • Mejores prácticas
  • Personalización
  • Contribuciones

Características

• Automatización: Activa flujos de trabajo basados en eventos (p. ej., apertura de issues) o en horarios (p. ej., nocturno).
• Colaboración bajo demanda: Activa flujos de trabajo en comentarios de issues y pull requests mencionando a la [CLI de Gemini] (p. ej., @gemini-cli /review).
• Extensible con herramientas: Aprovecha las capacidades de llamada a herramientas de los modelos Gemini para interactuar con otras CLIs como la [CLI de GitHub] (gh).
• Personalizable: Usa un archivo GEMINI.md en tu repositorio para proporcionar instrucciones y contexto específicos del proyecto a la [CLI de Gemini].

Inicio Rápido

Comienza a usar la CLI de Gemini en tu repositorio en solo unos minutos:

1. Obtén una clave de API de Gemini

Obtén tu clave de API desde Google AI Studio con cuotas gratuitas generosas.

2. Agrégala como secreto de GitHub

Almacena tu clave de API como un secreto llamado GEMINI_API_KEY en tu repositorio:

• Ve a Configuración > Secretos y variables > Actions de tu repositorio.
• Haz clic en Nuevo secreto del repositorio.
• Nombre: GEMINI_API_KEY, Valor: tu clave de API.

3. Actualiza tu .gitignore

Agrega las siguientes entradas a tu archivo .gitignore:

# Configuración de gemini-cli
.gemini/

# Credenciales de la App de GitHub
gha-creds-*.json

4. Elige un flujo de trabajo

Tienes dos opciones para configurar un flujo de trabajo:

Opción A: Usar el comando de configuración (Recomendado)

1. Inicia la CLI de Gemini en tu terminal:

   root@kitploit:~

   gemini
   

2. En la CLI de Gemini en tu terminal, escribe:

   root@kitploit:~

   /setup-github
   

Opción B: Copiar flujos de trabajo manualmente

1. Copia los flujos de trabajo preconstruidos del directorio examples/workflows al directorio .github/workflows de tu repositorio. Nota: también se debe copiar el flujo de trabajo gemini-dispatch.yml, que activa la ejecución de los flujos de trabajo.

5. ¡Pruébalo!

Revisión de Pull Requests:

• Abre un pull request en tu repositorio y espera la revisión automática.
• Comenta @gemini-cli /review en un pull request existente para activar manualmente una revisión.

Clasificación de Issues:

• Abre un issue y espera la clasificación automática.
• Comenta @gemini-cli /triage en issues existentes para activar manualmente la clasificación.

Asistencia general de IA:

• En cualquier issue o pull request, menciona @gemini-cli seguido de tu solicitud.
• Ejemplos:
  • @gemini-cli explica este cambio de código
  • @gemini-cli sugiere mejoras para esta función
  • @gemini-cli ayúdame a depurar este error
  • @gemini-cli escribe pruebas unitarias para este componente

Flujos de trabajo

Esta acción proporciona varios flujos de trabajo preconstruidos para diferentes casos de uso. Cada flujo de trabajo está diseñado para copiarse en el directorio .github/workflows de tu repositorio y personalizarse según sea necesario.

Dispatch de Gemini

Este flujo de trabajo actúa como un despachador central para la CLI de Gemini, enrutando solicitudes al flujo de trabajo adecuado según el evento que lo activó y el comando proporcionado en el comentario. Para obtener una guía detallada sobre cómo configurar el flujo de trabajo de despacho, consulta la documentación del flujo de trabajo de Dispatch de Gemini.

Clasificación de Issues

Esta acción se puede usar para clasificar Issues de GitHub automáticamente o según un horario. Para obtener una guía detallada sobre cómo configurar el sistema de clasificación de issues, consulta la documentación del flujo de trabajo de Clasificación de Issues de GitHub.

Revisión de Pull Requests

Esta acción se puede usar para revisar automáticamente los pull requests cuando se abren. Para obtener una guía detallada sobre cómo configurar el sistema de revisión de pull requests, consulta la documentación del flujo de trabajo de Revisión de PR de GitHub.

Asistente CLI de Gemini

Este tipo de acción se puede usar para invocar un asistente de IA Gemini conversacional de propósito general dentro de los pull requests e issues para realizar una amplia gama de tareas. Para obtener una guía detallada sobre cómo configurar el flujo de trabajo general de la CLI de Gemini, consulta la documentación del flujo de trabajo del Asistente Gemini.

Configuración

Entradas

• gcp_location: (Opcional) La ubicación de Google Cloud.

• gcp_project_id: (Opcional) El ID del proyecto de Google Cloud.

• gcp_service_account: (Opcional) El correo electrónico de la cuenta de servicio de Google Cloud.

• gcp_workload_identity_provider: (Opcional) El Proveedor de Identidad de Carga de Trabajo de Google Cloud.

• gcp_token_format: (Opcional, por defecto: access_token) El formato del token para la autenticación. Establécelo en "access_token" para generar tokens de acceso (requiere cuenta de servicio), o déjalo vacío para WIF directo. Puede ser "access_token" o "id_token".

• gcp_access_token_scopes: (Opcional, por defecto: https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/userinfo.email,https://www.googleapis.com/auth/userinfo.profile) Los alcances del token de acceso cuando se usa el formato de token "access_token". Lista separada por comas de alcances OAuth 2.0.

Salidas

• summary: La salida resumida de la ejecución de la CLI de Gemini.

• error: La salida de error de la ejecución de la CLI de Gemini, si la hubiera.

Variables de repositorio

Recomendamos establecer los siguientes valores como variables de repositorio para que puedan reutilizarse en todos los flujos de trabajo. Alternativamente, puedes configurarlos en línea como entradas de acción en flujos de trabajo individuales o para anular valores a nivel de repositorio.

[!WARNING] No uses la variable de entorno DEBUG, ya que provoca que la CLI de Gemini se cuelgue esperando que el depurador de Node se conecte.

Para agregar una variable de repositorio:

1. Ve a Configuración > Secretos y variables > Actions > Nueva variable de tu repositorio.
2. Ingresa el nombre y el valor de la variable.
3. Guarda.

Para obtener detalles sobre las variables de repositorio, consulta la documentación de GitHub sobre variables.

Secretos

Puedes establecer los siguientes secretos en tu repositorio:

Para agregar un secreto:

1. Ve a Configuración > Secretos y variables > Actions > Nuevo secreto del repositorio de tu repositorio.
2. Ingresa el nombre y el valor del secreto.
3. Guarda.

Para más información, consulta la documentación oficial de GitHub sobre la creación y uso de secretos cifrados.

Autenticación

Esta acción requiere autenticación tanto en los servicios de Google (para la IA de Gemini) como en la API de GitHub.

Autenticación de Google

Elige el método de autenticación que mejor se adapte a tu caso de uso:

1. Clave de API de Gemini: El método más simple para proyectos que no requieren integración con Google Cloud.
2. Federación de Identidad de Carga de Trabajo: El método más seguro para autenticarse en los servicios de Google Cloud.

Autenticación de GitHub

Puedes autenticarte en GitHub de dos maneras:

1. GITHUB_TOKEN por defecto: Para casos de uso simples, la acción puede usar el GITHUB_TOKEN por defecto proporcionado por el flujo de trabajo.
2. App de GitHub personalizada (Recomendado): Para la autenticación más segura y flexible, recomendamos crear una App de GitHub personalizada.

Para obtener instrucciones detalladas de configuración tanto para la autenticación de Google como de GitHub, consulta la documentación de Autenticación.

Observabilidad

Esta acción se puede configurar para enviar datos de telemetría (trazas, métricas y registros) a tu propio proyecto de Google Cloud. Esto te permite monitorear el rendimiento y el comportamiento de la [CLI de Gemini] dentro de tus flujos de trabajo, proporcionando información valiosa para la depuración y la optimización.

Para obtener instrucciones detalladas sobre cómo configurar la observabilidad, consulta la documentación de Observabilidad.

Extensiones

La CLI de Gemini se puede extender con funcionalidades adicionales a través de extensiones. Estas extensiones se instalan desde su código fuente en sus repositorios de GitHub.

Para obtener instrucciones detalladas sobre cómo configurar extensiones, consulta la documentación de Extensiones.

Mejores prácticas

Para garantizar la seguridad, confiabilidad y eficiencia de tus flujos de trabajo automatizados, recomendamos encarecidamente seguir nuestras mejores prácticas. Estas pautas cubren áreas clave como la seguridad del repositorio, la configuración del flujo de trabajo y la supervisión.

Recomendaciones clave:

• Asegurar tu repositorio: Implementar protección de ramas y etiquetas, y restringir los aprobadores de pull requests.
• Configuración del flujo de trabajo: Usar la Federación de Identidad de Carga de Trabajo para una autenticación segura a Google Cloud, gestionar los secretos de manera efectiva y fijar las versiones de las acciones para evitar cambios inesperados.
• Supervisión y auditoría: Revisar periódicamente los registros de las acciones y habilitar OpenTelemetry para obtener información más detallada sobre el rendimiento y el comportamiento.

Para obtener una guía completa sobre cómo asegurar tu repositorio y flujos de trabajo, consulta nuestra documentación de Mejores prácticas.

Personalización

Crea un archivo GEMINI.md en la raíz de tu repositorio para proporcionar contexto e instrucciones específicos del proyecto a la [CLI de Gemini]. Esto es útil para definir convenciones de codificación, patrones arquitectónicos u otras pautas que el modelo debe seguir para un repositorio determinado.

Contribuciones

¡Las contribuciones son bienvenidas! Consulta la Guía de contribución de la CLI de Gemini para obtener más detalles sobre cómo comenzar.