Compound Reviewer Bot

A code review robot powered by Groq's Compound Beta model for automated pull request reviews

Usage

1. Create a GitHub App

• Go to https://github.com/settings/apps/new
• Set the webhook URL to your deployed server (e.g., https://your-app-url/api/github/webhooks)
• Set permissions:
  • Repository: Contents (Read), Pull requests (Read & Write), Issues (Read & Write), Actions (Read)
  • Subscribe to Pull request events
• Download your private key after creation
• Note your App ID, Client Secret, and Webhook Secret

2. Configure Environment Variables

Create a .env file in your project root:

APP_ID=your_app_id
PRIVATE_KEY=your_private_key_contents
WEBHOOK_SECRET=your_webhook_secret
GROQ_API_KEY=your_groq_api_key
GROQ_MODEL=compound-beta

3. Install Dependencies and Build

npm install
npm run build

4. Run Locally (for development)

npm start

Visit http://localhost:3000 for setup instructions.

5. Deploy

Deploy to your preferred platform (Vercel, Heroku, AWS, etc.) and set the environment variables in your host's dashboard.

6. Install the App on Your Repository

• Go to your app's page on GitHub and install it on your target repository.

7. Test

• Create a pull request in your repository. The bot will automatically review the PR and post comments.

Notes

• The bot only works as a GitHub App (not as a GitHub Action).
• Make sure your webhook URL is accessible from GitHub.
• For more details, see the Probot documentation: https://probot.github.io/docs/

Bot Usage

❗️⚠️ Due to cost considerations, BOT is only used for testing purposes and is currently deployed on AWS Lambda with ratelimit restrictions. Therefore, unstable situations are completely normal. It is recommended to deploy an app by yourself.

Install

Install: apps/compound-reviewer;

Configuration

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 GROQ_API_KEY with the value of your Groq API key (For Github Action integration, set it in secrets)

Start using

1. 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.
2. After git push update the pull request, cr bot will re-review the changed files

example:

ChatGPT-CodeReview/pull/21

Using Github Actions

actions/chatgpt-codereviewer

1. add the GROQ_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:
    # if: ${{ contains(github.event.*.labels.*.name, 'gpt review') }} # Optional; to run only when a label is attached
    runs-on: ubuntu-latest
    steps:
      - uses: your-username/compound-reviewer@main
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          GROQ_API_KEY: ${{ secrets.GROQ_API_KEY }}
          # Optional
          LANGUAGE: Chinese
          GROQ_API_ENDPOINT: https://api.groq.com/openai/v1
          GROQ_MODEL: compound-beta # Default is 'compound-beta', can be changed to any available Groq model
          PROMPT: # example: Please check if there are any confusions or irregularities in the following code diff:
          top_p: 1
          temperature: 1
          max_tokens: 10000
          MAX_PATCH_LENGTH: 10000
          IGNORE_PATTERNS: /node_modules/**/*,*.md
          INCLUDE_PATTERNS: *.js,*.ts

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

Note: This bot is now powered by Groq and uses the compound-beta model by default.

probot for more detail

Dev

Setup

# Install dependencies
npm install

# Build code
npm run build

# Run the bot
npm run 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

License

ISC © 2023 anc95