AI Code Reviewer é uma ação do GitHub que aproveita a API GPT-4 da OpenAI para fornecer feedback inteligente e sugestões sobre suas solicitações pull. Essa ferramenta poderosa ajuda a melhorar a qualidade do código e economiza tempo dos desenvolvedores ao automatizar o processo de revisão do código.
Para usar esta ação GitHub, você precisa de uma chave de API OpenAI. Se você não tiver uma, inscreva-se para obter uma chave de API no OpenAI.
Adicione a chave da API OpenAI como um segredo do GitHub em seu repositório com o nome OPENAI_API_KEY
. Você pode encontrar mais informações sobre os segredos do GitHub aqui.
Crie um arquivo .github/workflows/main.yml
em seu repositório e adicione o seguinte conteúdo:
name : AI Code Reviewer
on :
pull_request :
types :
- opened
- synchronize
permissions : write-all
jobs :
review :
runs-on : ubuntu-latest
steps :
- name : Checkout Repo
uses : actions/checkout@v3
- name : AI Code Reviewer
uses : your-username/ai-code-reviewer@main
with :
GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }} # The GITHUB_TOKEN is there by default so you just need to keep it like it is and not necessarily need to add it as secret as it will throw an error. [More Details](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret)
OPENAI_API_KEY : ${{ secrets.OPENAI_API_KEY }}
OPENAI_API_MODEL : " gpt-4 " # Optional: defaults to "gpt-4"
exclude : " **/*.json, **/*.md " # Optional: exclude patterns separated by commas
Substitua your-username
pelo seu nome de usuário do GitHub ou nome da organização onde o repositório do AI Code Reviewer está localizado.
Personalize a entrada exclude
se desejar ignorar a revisão de determinados padrões de arquivo.
Confirme as alterações em seu repositório e o AI Code Reviewer começará a trabalhar em suas futuras solicitações pull.
A ação GitHub do AI Code Reviewer recupera a diferença de pull request, filtra os arquivos excluídos e envia pedaços de código para a API OpenAI. Em seguida, ele gera comentários de revisão com base na resposta da IA e os adiciona à solicitação pull.
Contribuições são bem-vindas! Sinta-se à vontade para enviar problemas ou obter solicitações para melhorar a ação do GitHub do AI Code Reviewer.
Deixe o mantenedor gerar o pacote final ( yarn build
& yarn package
).
Este projeto está licenciado sob a licença MIT. Consulte o arquivo LICENSE para obter mais informações.