run-gemini-cli

Visão Geral

run-gemini-cli é uma GitHub Action que integra o Gemini ao seu fluxo de desenvolvimento através do Gemini CLI. Atua tanto como um agente autônomo para tarefas rotineiras críticas de codificação, quanto como um colaborador sob demanda para quem você pode delegar trabalho rapidamente.

Use-o para realizar revisões de pull requests no GitHub, triar issues, realizar análise e modificação de código, e muito mais usando o Gemini de forma conversacional (ex.: @gemini-cli corrija esta issue) diretamente nos seus repositórios GitHub.

• run-gemini-cli
  • Visão Geral
  • Funcionalidades
  • Guia Rápido
    • 1. Obtenha uma Chave de API do Gemini
    • 2. Adicione como um Segredo do GitHub
    • 3. Atualize seu .gitignore
    • 4. Escolha um Fluxo de Trabalho
    • 5. Teste
  • Fluxos de Trabalho
    • Gemini Dispatch
    • Triagem de Issues
    • Revisão de Pull Requests
    • Assistente Gemini CLI
  • Configuração
    • Entradas
    • Saídas
    • Variáveis do Repositório
    • Segredos
  • Autenticação
    • Autenticação do Google
    • Autenticação do GitHub
  • Observabilidade
  • Extensões
  • Melhores Práticas
  • Personalização
  • Contribuição

Funcionalidades

• Automação: Acione fluxos de trabalho com base em eventos (ex.: abertura de issue) ou agendas (ex.: noturno).
• Colaboração sob Demanda: Acione fluxos de trabalho em comentários de issues e pull requests mencionando o Gemini CLI (ex.: @gemini-cli /review).
• Extensível com Ferramentas: Aproveite as capacidades de chamada de ferramentas dos modelos Gemini para interagir com outros CLIs como o GitHub CLI (gh).
• Personalizável: Use um arquivo GEMINI.md no seu repositório para fornecer instruções e contexto específicos do projeto para o Gemini CLI.

Guia Rápido

Comece a usar o Gemini CLI no seu repositório em apenas alguns minutos:

1. Obtenha uma Chave de API do Gemini

Obtenha sua chave de API no Google AI Studio com quotas gratuitas generosas.

2. Adicione como um Segredo do GitHub

Armazene sua chave de API como um segredo chamado GEMINI_API_KEY no seu repositório:

• Vá para Configurações > Segredos e variáveis > Actions do seu repositório.
• Clique em Novo segredo do repositório.
• Nome: GEMINI_API_KEY, Valor: sua chave de API.

3. Atualize seu .gitignore

Adicione as seguintes entradas ao seu arquivo .gitignore:

# configurações do gemini-cli
.gemini/

# credenciais do GitHub App
gha-creds-*.json

4. Escolha um Fluxo de Trabalho

Você tem duas opções para configurar um fluxo de trabalho:

Opção A: Usar o comando de configuração (Recomendado)

1. Inicie o Gemini CLI no seu terminal:

   root@kitploit:~

   gemini
   

2. No Gemini CLI no seu terminal, digite:

   root@kitploit:~

   /setup-github
   

Opção B: Copiar fluxos de trabalho manualmente

1. Copie os fluxos de trabalho pré-construídos do diretório examples/workflows para o diretório .github/workflows do seu repositório. Nota: o fluxo de trabalho gemini-dispatch.yml também deve ser copiado, pois aciona a execução dos fluxos de trabalho.

5. Teste!

Revisão de Pull Request:

• Abra um pull request no seu repositório e aguarde a revisão automática.
• Comente @gemini-cli /review em um pull request existente para acionar manualmente uma revisão.

Triagem de Issues:

• Abra uma issue e aguarde a triagem automática.
• Comente @gemini-cli /triage em issues existentes para acionar manualmente a triagem.

Assistência Geral de IA:

• Em qualquer issue ou pull request, mencione @gemini-cli seguido da sua solicitação.
• Exemplos:
  • @gemini-cli explique esta mudança de código
  • @gemini-cli sugira melhorias para esta função
  • @gemini-cli me ajude a depurar este erro
  • @gemini-cli escreva testes unitários para este componente

Fluxos de Trabalho

Esta ação fornece vários fluxos de trabalho pré-construídos para diferentes casos de uso. Cada fluxo de trabalho foi projetado para ser copiado para o diretório .github/workflows do seu repositório e personalizado conforme necessário.

Gemini Dispatch

Este fluxo de trabalho atua como um despachante central para o Gemini CLI, roteando solicitações para o fluxo de trabalho apropriado com base no evento acionador e no comando fornecido no comentário. Para um guia detalhado sobre como configurar o fluxo de trabalho de despacho, acesse a documentação do fluxo de trabalho Gemini Dispatch.

Triagem de Issues

Esta ação pode ser usada para triar issues do GitHub automaticamente ou em uma agenda. Para um guia detalhado sobre como configurar o sistema de triagem de issues, acesse a documentação do fluxo de trabalho de Triagem de Issues no GitHub.

Revisão de Pull Requests

Esta ação pode ser usada para revisar automaticamente pull requests quando eles são abertos. Para um guia detalhado sobre como configurar o sistema de revisão de pull requests, acesse a documentação do fluxo de trabalho de Revisão de PR no GitHub.

Assistente Gemini CLI

Este tipo de ação pode ser usado para invocar um assistente de IA Gemini conversacional de uso geral dentro de pull requests e issues para realizar uma ampla gama de tarefas. Para um guia detalhado sobre como configurar o fluxo de trabalho Gemini CLI de uso geral, acesse a documentação do fluxo de trabalho do Assistente Gemini.

Configuração

Entradas

• gcp_location: (Opcional) A localização do Google Cloud.

• gcp_project_id: (Opcional) O ID do projeto Google Cloud.

• gcp_service_account: (Opcional) O e-mail da conta de serviço do Google Cloud.

• gcp_workload_identity_provider: (Opcional) O provedor de identidade de carga de trabalho do Google Cloud.

• gcp_token_format: (Opcional, padrão: access_token) O formato do token para autenticação. Defina como "access_token" para gerar tokens de acesso (requer conta de serviço) ou deixe vazio para WIF direto. Pode ser "access_token" ou "id_token".

• gcp_access_token_scopes: (Opcional, padrão: https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/userinfo.email,https://www.googleapis.com/auth/userinfo.profile) Os escopos do token de acesso ao usar token_format "access_token". Lista separada por vírgulas de escopos OAuth 2.0.

Saídas

• summary: A saída resumida da execução do Gemini CLI.

• error: A saída de erro da execução do Gemini CLI, se houver.

Variáveis do Repositório

Recomendamos definir os seguintes valores como variáveis do repositório para que possam ser reutilizados em todos os fluxos de trabalho. Alternativamente, você pode defini-los inline como entradas da ação em fluxos de trabalho individuais ou para substituir valores de nível de repositório.

[!WARNING] Não use a variável de ambiente DEBUG, pois ela faz com que o Gemini CLI pare, aguardando a conexão do depurador do Node.

Para adicionar uma variável de repositório:

1. Vá para Configurações > Segredos e variáveis > Actions > Nova variável do seu repositório.
2. Insira o nome e o valor da variável.
3. Salve.

Para detalhes sobre variáveis de repositório, consulte a documentação do GitHub sobre variáveis.

Segredos

Você pode definir os seguintes segredos no seu repositório:

Para adicionar um segredo:

1. Vá para Configurações > Segredos e variáveis > Actions > Novo segredo do repositório do seu repositório.
2. Insira o nome e o valor do segredo.
3. Salve.

Para mais informações, consulte a documentação oficial do GitHub sobre criação e uso de segredos criptografados.

Autenticação

Esta ação requer autenticação tanto nos serviços do Google (para o Gemini AI) quanto na API do GitHub.

Autenticação do Google

Escolha o método de autenticação que melhor se adequa ao seu caso de uso:

1. Chave de API Gemini: O método mais simples para projetos que não exigem integração com Google Cloud.
2. Federação de Identidade de Carga de Trabalho: O método mais seguro para autenticar em serviços do Google Cloud.

Autenticação do GitHub

Você pode autenticar no GitHub de duas maneiras:

1. GITHUB_TOKEN padrão: Para casos de uso mais simples, a ação pode usar o GITHUB_TOKEN padrão fornecido pelo fluxo de trabalho.
2. GitHub App personalizado (Recomendado): Para a autenticação mais segura e flexível, recomendamos criar um GitHub App personalizado.

Para instruções detalhadas de configuração para autenticação do Google e do GitHub, acesse a documentação de Autenticação.

Observabilidade

Esta ação pode ser configurada para enviar dados de telemetria (traces, métricas e logs) para seu próprio projeto Google Cloud. Isso permite monitorar o desempenho e o comportamento do Gemini CLI em seus fluxos de trabalho, fornecendo insights valiosos para depuração e otimização.

Para instruções detalhadas sobre como configurar a observabilidade, acesse a documentação de Observabilidade.

Extensões

O Gemini CLI pode ser estendido com funcionalidades adicionais através de extensões. Essas extensões são instaladas a partir do código-fonte de seus repositórios no GitHub.

Para instruções detalhadas sobre como configurar extensões, acesse a documentação de Extensões.

Melhores Práticas

Para garantir a segurança, confiabilidade e eficiência de seus fluxos de trabalho automatizados, recomendamos fortemente seguir nossas melhores práticas. Essas diretrizes cobrem áreas-chave como segurança do repositório, configuração de fluxo de trabalho e monitoramento.

Principais recomendações:

• Protegendo seu Repositório: Implementando proteção de branches e tags, e restringindo aprovadores de pull requests.
• Configuração de Fluxo de Trabalho: Usando Federação de Identidade de Carga de Trabalho para autenticação segura no Google Cloud, gerenciando segredos de forma eficaz e fixando versões de ações para evitar mudanças inesperadas.
• Monitoramento e Auditoria: Revisando regularmente os logs da ação e ativando o OpenTelemetry para insights mais profundos sobre desempenho e comportamento.

Para um guia abrangente sobre como proteger seu repositório e fluxos de trabalho, consulte nossa documentação de Melhores Práticas.

Personalização

Crie um arquivo GEMINI.md na raiz do seu repositório para fornecer contexto e instruções específicos do projeto para o Gemini CLI. Isso é útil para definir convenções de codificação, padrões arquiteturais ou outras diretrizes que o modelo deve seguir para um determinado repositório.

Contribuição

Contribuições são bem-vindas! Consulte o Guia de Contribuição do Gemini CLI para mais detalhes sobre como começar.