CodeReview BOT

A code review robot powered by ChatGPT

Usage

Install

Install: apps/cr-gpt;

Configuration

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

Start using

The robot will automatically do the code review when you create a new Pull request, the review information will show in the pr timeline / file changes part.
After git push update the pull request, cr bot will re-review the changed files

example:

ChatGPT-CodeReview/pull/21

Using Github Actions

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

name: Code Review

permissions: write-all

on:
  pull_request:
    types: [opened, reopened, synchronize]
  push:
     branches: [ "master" ]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: xiaoquisme/ChatGPT-CodeReview@main
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          # Optional
          LANGUAGE: Chinese
          MODEL:
          top_p: 1
          temperature: 1
          CODE_REVIEW_PROMPT: "Bellow is the code patch.
    Write a detailed review {answerLanguage} of any issues you can find in the form of a table with a row for each issue and the following columns:
    - Issue type (e.g. bug, style, etc.)
    - Issue importance (e.g. low, medium, high)
    - Issue description
    - Recommended fix
    {patch}"

Self-hosting

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

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

this project is inpired by codereview.gpt

xiaoquisme/ChatGPT-CodeReview