rdelfin/min-review-bot

min-review-bot

Do you have overly complex owner rules in your Github repo? Is it hard to figure out who the minimum set of owners needed for a review are? This tool helps you solve this issue. It will:

• Scan through all the PRs on a given repo for the set of owners required
• Compute the real minumum set of reviewers required to merge
• Leave a comment on the PR showing the corresponding boolean expression

It can be configured to run on any machine, and only requires a GitHub app as well as a SQLite DB which can be re-generated on restart.

Configuration

We recommend setting this up with docker compose. We provided a sample docker-compose.yaml file in the root directory, but you basically want to put:

version: '3'
services:
  daemon:
    image: rdelfin/min_review_bot:latest
    volumes:
      - ./config.toml:/etc/reviewbot/config.toml:ro
      - ./private_key.pem:/etc/reviewbot/private_key.pem:ro
      - ./data:/var/cache/reviewbot:rw
    restart: always
    network_mode: "host"
    command: ["min_review_daemon", "--config", "/etc/reviewbot/config.toml"]

And this should be accompanied by a matching config.toml file in that directory:

repo = "YOUR_REPO"
bot_username = "YOUR BOT'S USERNAME"
sleep_period = { secs = 60, nanos = 0 }
# This should be a list of users that have this bot enabled. We will change this
# to a blocklist in a future release
users = [
    "user1",
    "user2",
]
db_path = "/var/cache/reviewbot/data.db"

[github]
private_key_path = "PATH_TO_GITHUB_APP_PEM_FILE"
app_id = YOUR_GITHUB_APP_ID

You can then run:

$ docker compose -d

And you should have a running application.

Creating a Github application

As you can see, this requires creating a github app to put down the comments in your place. We recommend following this guide to create the app. You will need a github APP ID as well as a .pem file to authenticate. Place these in the appropriate fields in the config.