This guide explains how to complete Reviewpad migrations.
Migrate from the GitHub Action to the GitHub App
Using Reviewpad action is a great way to get started with Reviewpad. However, it has some limitations. Depending if you are using Reviewpad action with a GitHub token you won't be able to use all Reviewpad built-ins. Also, some of the Reviewpad use cases won't be possible to implement.
To overcome these limitations, you should migrate to the Reviewpad GitHub App. The migration is a simple process that can be completed in a few steps.
Step 1. Navigate to the Reviewpad GitHub App page
Open the Reviewpad GitHub App page and click the green button
Step 2. Choose which repositories to install Reviewpad on
You can choose to install Reviewpad on all repositories or select specific repositories.
Once you have selected the option you want, click the green button
After you click the
Install button you will be redirected to Reviewpad documentation. You can close it and continue with this migration.
Step 3. Configure Reviewpad
If you already have a Reviewpad configuration file, you can skip this step.
If you don't have a Reviewpad configuration file, create a file called
reviewpad.yml in the root of your repository and add the following content:
- name: label-pull-request-with-size
- rule: $size() <= 30
- rule: $size() > 30 && $size() <= 100
- rule: $size() > 100
Step 4. Disable Reviewpad action
Finally, disable the Reviewpad action from your repository. You can do this by removing the workflow file, that executes the Reviewpad action, from your repository.
If you followed our configuration guide, you can find the workflow file in
.github > workflows > reviewpad.yml.
The workflow file should look like this. Remove it and you're done.