Getting Started

A short guide on setting up GitRevue with your GitHub repositories. If you already have GitRevue set up you may find the Configuration Reference more useful.

Prerequisites

Before getting started with GitRevue, make sure you have the following:

  • A GitHub account
  • Permission to install a GitHub App for a repository hosted on GitHub

Let's Get Started

  1. Go to https://github.com/apps/gitrevue and install the GitRevue App.
  2. Select the GitHub organisation and repositories you want to use with GitRevue.
  3. Click the green Install button
  4. Add a .gitrevue.yaml file to your repository. The sample below tells GitRevue to fail the review if the PR exceeds 1,000 additions/deletions.
maximum_modifications: 1000
  1. Commit the .gitrevue.yaml configuration, push and open a pull request.
  2. View the Checks tab on your pull request to see if your review passed or failed.

Further Reading