Reviewpad GitHub Action

Warning

We have stop updating the Reviewpad action at the end of the v3.x series.

This means that the version 3.27.0 will be the last supported version by Reviewpad.

For current users of the actions, we will keep providing support on the action but we recommend that you migrate to the Reviewpad GitHub App.

To migrate from the GitHub action to the GitHub app:

1. Install the GitHub app
2. Remove the Reviewpad action workflow file.

The GitHub app is compatible with the action and will pick up the Reviewpad configuration file at the root of the repository.

For more details on this decision, check out the discussion.

Note

🔥 Latest Stable Version: v3.x (Faro Edition)

🤔 For questions, check out the discussions.

📃 For the legacy documentation, check out this document and the official documentation.

🙌 Join our community on discord!

This action runs the docker image reviewpad/action.

It reads and automates the pull request workflows specified in the reviewpad.yml configuration file.

These workflows can be used to automatically label, assign reviewers, comment, merge and close pull requests.

For example, the following reviewpad.yml file:

api-version: reviewpad.com/v3.x

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

Specifies a workflow to automatically add a label based on the size of the pull request.

Note You can find examples of more use cases in the documentation.

For more information on the release procedure, check the RELEASE.md document.

Inputs

• event: The GitHub event context that trigger the action. Uses default ${{ toJSON(github) }}
• file: The local location of the Reviewpad configuration file. Uses default ./reviewpad.yml. Ignored if file_url is set.
• file_url (OPTIONAL): The remote location of the Reviewpad configuration file. If set, it will ignore the input file.
• token: Uses default ${{ github.token }}

Usage

Basic

Add the following step to your GitHub Action job:

- name: Run reviewpad action
  uses: reviewpad/[email protected]

:link: Remote configuration

You can run reviewpad action with a remote configuration by setting the input file_url:

- name: Run reviewpad action
  uses: reviewpad/[email protected]
  with:
    file_url: https://github.com/reviewpad/action/blob/main/templates/start.yml

:key: GitHub token

By default this action uses the github-actions[bot] token.

As described in the official GitHub documentation:

When you use the repository's GITHUB_TOKEN to perform tasks, events triggered by the GITHUB_TOKEN will not create a new workflow run.

If you want to use more advanced features such as the merge feature, we recommend that you explicitly provide a PAT (Personal Access Token) to run this action:

- name: Run reviewpad action
  uses: reviewpad/[email protected]
  with:
    token: ${{ secrets.GH_TOKEN }}

Please follow this link to know more.