CodeReview BOT

A code review robot powered by Bard

Translation Versions: ENGLISH | 中文简体 | 中文繁體 | 한국어 | 日本語

Configuration

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

Using Github Actions

add the BARD_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:
    if: ${{ contains(github.event.*.labels.*.name, 'gpt review') }} # Optional; to run only when a label is attached
    runs-on: ubuntu-latest
    steps:
      - uses: amondnet/bard-codereview@v0
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          BARD_API_KEY: ${{ secrets.BARD_API_KEY }}
          # Optional
          LANGUAGE: Korean

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