This guide describes the setup for Reviewpad GitHub Action.

Reviewpad Action runs at the level of a single GitHub repository.

To enable it, you just need to perform the following steps.

Step 1. Configure the GitHub action

Configure Reviewpad as a GitHub Action in a pull_request workflow:

name: Reviewpad Action
on:
  pull_request

jobs:
  reviewpad-action:
    runs-on: ubuntu-latest
    steps:
      - name: Running reviewpad action
        uses: reviewpad/[email protected]

The source code of the GitHub Action can be found in the GitHub repository reviewpad/action.

Step 2. Add revy.yml to the root of the repository

Add the configuration file revy.yml to the root of your repository.

This file follows a particular configuration language called Revy.

❗️

Terms and Conditions

By running this action you’re agreeing with Reviewpad’s Terms and Conditions.