robin ai reviewer

Robin AI

Nomeado após o assistente de Batman, Robin AI é um projeto do GitHub de código aberto que analisa automaticamente as solicitações do GitHub Pull, fornecendo uma pontuação (0-100), sugeridas melhorias e código de amostra para melhoria.

Instalação

Para usar o Robin AI no seu projeto GitHub, você precisará adicioná -lo como uma ação do GitHub. Aqui está como:

1. No seu repositório do GitHub, navegue até a guia "Ações".
2. Clique no botão "Novo fluxo de trabalho".
3. Selecione a opção de "configurar um fluxo de trabalho".
4. Copie e cole o seguinte código no novo arquivo:

 name : Robin AI Reviewer

on :
  pull_request :
    branches : [main]
    types :
      - opened
      - reopened
      - ready_for_review

jobs :
  build :
    runs-on : ubuntu-latest
    steps :
      - name : Checkout code
        uses : actions/checkout@v3
      - name : Robin AI Reviewer
        uses : Integral-Healthcare/robin-ai-reviewer@v[INSERT_LATEST_RELEASE]
        with :
          GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
          OPEN_AI_API_KEY : ${{ secrets.OPEN_AI_API_KEY }}
          files_to_ignore : |
            "README.md"
            "assets/*"
            "package-lock.json"

5. Salve o arquivo com um nome como robin.yml .
6. Crie um segredo no seu repositório do GitHub chamado OPEN_AI_API_KEY e defina -o para o valor da sua tecla API API.

Com essas etapas concluídas, o Robin AI será executado automaticamente toda vez que uma solicitação de tração é aberta ou editada no repositório do seu GitHub.

Argumentos

Nome	Obrigatório	Valor padrão	Descrição
GITHUB_TOKEN	Sim	Fornecido automaticamente	Um token de acesso ao github com o repo e os escopos pull_request .
OPEN_AI_API_KEY	Sim	N / D	Uma chave da API do portal de desenvolvedor da IA ​​Open.
gpt_model_name	Não	gpt-3.5-turbo	O nome do modelo GPT a ser usado para geração de texto.
github_api_url	Não	https://api.github.com	O URL para o ponto final da API do GitHub. (Somente relevante para os clientes corporativos.)
files_to_ignore	Não	(String vazia)	Uma lista delimitada de espaço em branco para ignorar.

Open_ai_api_key

Você terá que navegar no portal de desenvolvedores do OpenAI para gerar uma chave da API. Além disso, você terá que colocar um cartão em arquivo antes que a chave da API se torne ativa. Você pode ver os detalhes de preços aqui, mas para o modelo padrão gpt-3.5-turbo , o preço é de $0.0015 / 1K tokens , o que se traduz em <$ 2 / mês, mesmo para organizações que fazem solicitações diárias de tração.

Uso

Quando Robin Ai for executado, ele publicará um comentário sobre a solicitação de tração com sua pontuação em 100, melhorias sugeridas e código de amostra para melhoria. Você pode usar essas informações para melhorar a qualidade do seu código e aumentar a probabilidade de suas solicitações de tração.

Desempenho

Grande ênfase foi colocada em garantir um tempo de execução com desempenho.

Métrica	Valor
Tamanho da imagem do docker	15,6 MB
Tempo de execução de ação média	14s

A imagem do Docker para Robin AI tem um tamanho de 15,6 MB, que é relativamente pequeno e deve ser rápido em baixar e usar. Em média, o tempo de execução da ação do Robin Ai Github é de 14 segundos, o que significa que ele deve ser capaz de processar solicitações de puxar de maneira rápida e eficiente. Essas métricas podem variar dependendo de fatores como o tamanho e a complexidade do código que está sendo revisado, a velocidade da conexão com a Internet e a disponibilidade da API da IA ​​aberta.

Demonstração

Aqui está um link para a demonstração

Contribuindo

Se você quiser contribuir com Robin AI, recebemos sua opinião! Sinta -se à vontade para enviar questões ou obter solicitações em nosso repositório do GitHub. Você também pode me enviar uma mensagem no Twitter.

Licença

Robin AI é licenciado sob a licença do MIT. Consulte LICENSE para obter mais informações.