AutoReviewer

? Revisões automatizadas de código desenvolvidas por ChatGPT?

Uma ação do GitHub usa GPT-4 da OpenAI para realizar revisões automatizadas de código. Quando você cria um PR, nossa ação irá revisar automaticamente o código e sugerir alterações, assim como um revisor de código humano faria.

Como usar

• Obtenha uma chave de API da OpenAI
• Adicione-o como um segredo do GitHub
• Configure uma ação que seja executada em cada PR

 name : ' code-review '
on : # rebuild any PRs and main branch changes
  pull_request :
jobs :
  code-review :
    runs-on : ubuntu-latest
    permissions :
      contents : read
      pull-requests : write
    steps :
      - uses : actions/checkout@v3
      - uses : gvasilei/[email protected]
        env :
          NODE_OPTIONS : ' --experimental-fetch '
        with :
          github_token : ${{ secrets.GITHUB_TOKEN }}
          openai_api_key : ${{ secrets.OPENAI_API_KEY }}
          exclude_files : ' *.json, *.md, *.yml ' # optionally exclude files based on a wildcard expression. 

• Ou quando um rótulo é adicionado

 name : ' code-review '
on : # rebuild any PRs and main branch changes
  pull_request :
    types : [labeled]
jobs :
  code-review :
    if : ${{ contains( github.event.label.name, 'AutoReview') }}
    runs-on : ubuntu-latest
    permissions :
      contents : read
      pull-requests : write
    steps :
      - uses : actions/checkout@v3
      - uses : gvasilei/[email protected]
        env :
          NODE_OPTIONS : ' --experimental-fetch '
        with :
          github_token : ${{ secrets.GITHUB_TOKEN }}
          openai_api_key : ${{ secrets.OPENAI_API_KEY }}
          exclude_files : ' *.json, *.md, *.yml ' # optionally exclude files based on a wildcard expression. 

Parâmetros de entrada

Parâmetro	Obrigatório	Padrão	Descrição
github_token	Verdadeiro		Necessário para comunicação com GitHub. Gerado automaticamente pelo GHA
openai_api_key	Verdadeiro		Chave de API OpenAI
nome_modelo	Falso	gpt-3.5-turbo	Modelo de bate-papo OpenAI. Atualmente suporta gpt-4 e gpt-3.5-turbo
temperatura_modelo	Falso	0	Temperatura do modelo OpenAI
arquivos_excludentes	Falso		Forneça uma expressão curinga para excluir arquivos da revisão de código. Por exemplo, *.md excluirá todos os arquivos Markdown. Múltiplas expressões são suportadas por vírgulas, por exemplo, *.js, *.cjs

? Benefícios

Usar nossa ação GitHub traz muitos benefícios, como:

• Revisões de código mais rápidas
• Feedback mais consistente
• Maior produtividade
• Qualidade de código aprimorada

? Limitações

• Esta ação do GitHub ainda está em desenvolvimento inicial.
• Embora a ação suporte gpt-4 e gpt-3.5-turbo , gpt-4 oferece sugestões muito melhores.

? Contribuindo

Se você tiver alguma ideia ou melhoria em nossa ação GitHub, sinta-se à vontade para enviar um PR. Aceitamos todas as contribuições!