Robô para fazer Code Reviews com ChatGPT
Versão traduzida em Português
- Go to the repo homepage which you want integrate this bot
- click
settings
- click
actions
undersecrets and variables
- Change to
Variables
tab, create a new variableOPENAI_API_KEY
with the value of your open api key
- 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.
- Depois de um
git push
atualizando uma pull request, o bot fará review novamente nos arquivos alterados.
example:
this is a recommended way as github bot is serving on a humble vps, I can't make sure it's always stable
- add the
OPEN_API_KEY
to your github actions secrets - 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
- clone code
- copy
.env.example
to.env
, and fill the env variables - install deps and run
npm i
npm -i g pm2
npm run build
pm2 start pm2.config.cjs
probot for more detail
# Install dependencies
npm install
# Run the bot
npm start
# 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
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.
O projeto original foi criado pelo anc95 e inspirado no codereview.gpt.
ISC © 2023 anc95