Connect to GitHub

This page will help you connect your Reviewpad user to GitHub.

Reviewpad can communicate with both GitHub.com and GitHub Enterprise to retrieve and propagate information to GitHub. This means that a comment made by you in Reviewpad will automatically be propagated to GitHub and vice versa. This way you can use Reviewpad without disrupting the workflow of your team if they are not still using it.

Creating a personal access token

Reviewpad uses personal access tokens to identify your Reviewpad user to a GitHub username and perform actions via the GitHub API. You can follow the GitHub instructions on how to ↗︎create a personal access token.

Reviewpad requires different scopes depending on how you want to use it:

Public Repositories

ScopeAdd/Read/RemoveComment
read:user
repo:public_repo
repo:*

Private Repositories

ScopeAdd/Read/RemoveComment
read:user
repo:public_repo
repo:*

Note that you will always need to add the read:user scope so that Reviewpad can match your GitHub username.

If you want to use webhooks to automatically synchronise your repositories from GitHub you will need to have the appropriated permissions in your GitHub account as well as adding the scopes admin:repo_hook and admin:org_hook when creating the token.