This guide describes how to install Reviewpad ⚡
Some actions require a GitHub token 🔑
To install Reviewpad with a GitHub token please follow this tutorial
Reviewpad runs as a GitHub action at the level of a single GitHub repository, which means that you need to install Reviewpad for each repository where you wish to run it.
To install Reviewpad on a repository, please follow the following steps.
Step 1. Open the GitHub project on your IDE
Open the GitHub project where you wish to install Reviewpad.
Use your IDE for this since we will be adding new files to the project.
Step 2. Add
Reviewpad Action workflow file
At the root of your repository navigate to
.github > workflows (This is where your project GitHub actions live. If you don't have these folders, please create them).
Add the file
reviewpad.yml and copy the following content:
name: Reviewpad Action
- name: Running reviewpad action
Step 3. Add
reviewpad.yml to the root of your repository
Let's add a simple Reviewpad configuration. You can change it later on 💪
On the root of your repository create the
reviewpad.yml file and copy the following content:
- name: label-pull-request-with-size
- rule: $size() <= 30
- rule: $size() > 30 && $size() <= 100
- rule: $size() > 100
This particular configuration will label the pull requests based on their size.
By running this action you're agreeing with Reviewpad's Terms and Conditions.