Skip to main content
Version: v3

Migrations

Migrate from the GitHub Action to the GitHub App​

Why?​

Using Reviewpad action is a great way to get started with Reviewpad. However, it has some limitations.

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.

caution

To install the Reviewpad GitHub App, you need to be an admin of the GitHub organization where you want to install it.

If you are not an admin, you can ask your admin to install the Reviewpad GitHub App.

Step 1. Navigate to the Reviewpad GitHub App page​

Open the Reviewpad GitHub App page and click the green button Install.

Reviewpad Installation - Step 1

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 Install.

Reviewpad Installation - Step 2

info

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​

tip

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:

reviewpad.yml
api-version: reviewpad.com/v3.x

labels:
    small:
        color: 294b69
    medium:
        color: a8c3f7
    large:
        color: 8a2138

workflows:
    - name: label-pull-request-with-size
      if:
          - rule: $size() <= 30
            extra-actions:
                - $addLabel("small")
          - rule: $size() > 30 && $size() <= 100
            extra-actions:
                - $addLabel("medium")
          - rule: $size() > 100
            extra-actions:
                - $addLabel("large")

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.

Remove it and you're done.

Reviewpad Delete Action