Configuration

Now that you have installed Reviewpad it's time to configure it.

The Reviewpad configuration is a YAML file that defines the workflows that to follow to automate your pull request process.

In this example we will create a configuration that checks the size of a pull request and adds a label with the size.

Add reviewpad.yml to the root of your repository

Reviewpad will look for a reviewpad.yml file in the root of your repository and follow the workflows defined in it.

Create a file called reviewpad.yml in the root of your repository and add the following content:

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")

That's it! 🎉

Reviewpad will run on every pull request and follow the workflows defined in the reviewpad.yml configuration file.

👉 Don't forget to commit and push the reviewpad.yml file to your repository.

Next steps

Now that you have configured Reviewpad you can start using it to automate your pull request process.

Have a look at the use cases to see how Reviewpad can help you.

Terms and Conditions

By running Reviewpad, you are agreeing with Reviewpad's Terms and Conditions.