CodeReview BOT

Robô para fazer Code Reviews com ChatGPT

Versão traduzida em Português

Como usar

Configuração

1. Go to the repo homepage which you want integrate this bot
2. click settings
3. click actions under secrets and variables
4. Change to Variables tab, create a new variable OPENAI_API_KEY with the value of your open api key

Comece usando

1. O robô vai fazer code review automaticamente a partir do momento que você criar um novo pull request. As informações do review estarão disponíveis em comentário.
2. Depois de um git push atualizando uma pull request, o bot fará review novamente nos arquivos alterados.

example:

ChatGPT-CodeReview/pull/21

Usando Github Actions (Recomendado)

this is a recommended way as github bot is serving on a humble vps, I can't make sure it's always stable

actions/chatgpt-codereviewer

1. add the OPEN_API_KEY to your github actions secrets
2. create .github/workflows/cr.yml add bellow content

name: Code Review

permissions:
  contents: read
  pull-requests: write

on:
  pull_request:
    types: [opened, reopened, synchronize]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: victornery/ChatGPT-CodeReview@main
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          # Optional
          MODEL:
          top_p: 1
          temperature: 1

Self-hosting

1. clone code
2. copy .env.example to .env, and fill the env variables
3. install deps and run

npm i
npm -i g pm2
npm run build
pm2 start pm2.config.cjs

probot for more detail

Dev

Setup

# Install dependencies
npm install

# Run the bot
npm start

Docker

# 1. Build container
docker build -t cr-bot .

# 2. Start container
docker run -e APP_ID=<app-id> -e PRIVATE_KEY=<pem-value> cr-bot

Contributing

If you have suggestions for how cr-bot could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

Credit

O projeto original foi criado pelo anc95 e inspirado no codereview.gpt.

Licença

ISC © 2023 anc95