GitHub
Review pull requests on github.com, signed in with the browser, a personal access token or the gh CLI.
GitHub is the service Revue supports most fully: everything in these docs works on it. You can connect several GitHub accounts, next to Bitbucket and Forgejo ones.
Sign in#
The easiest way is the browser:
- On the welcome screen click GitHub, or in Settings → Accounts click Add GitHub account.
- Click Sign in with GitHub. A tab opens on github.com, and Revue shows a code (already on your clipboard).
- Sign in on github.com if it asks, paste the code and click Continue.
- Click Authorize, then come back to Revue. It carries on by itself.
Guide: Sign in with a personal access token#
- Click Advanced: use a token instead under Sign in with GitHub.
- Click Create token. GitHub's new-token page opens with the right scopes ticked and the name "Revue".
- Pick an expiry, click Generate token on GitHub and copy the token.
- Paste it into the field (
ghp_… or github_pat_…) and click Connect GitHub.
A classic token needs these scopes:
| Scope | What Revue uses it for |
|---|---|
repo | Read repositories and pull requests, post reviews |
read:org | See organization and team review requests |
A fine-grained token works too, with Pull requests: Read and write. It only reaches the repositories you choose when you create it.
Use the gh CLI or GITHUB_TOKEN#
Already signed in with gh auth login, or have GITHUB_TOKEN / GH_TOKEN set? Revue can use that token:
- On the sign-in form, under Advanced: use a token instead, click Use the gh CLI.
- Or in Settings → Accounts, turn on Also sign in with the gh CLI or GITHUB_TOKEN / GH_TOKEN.
More about this, and about REVUE_GITHUB_TOKEN, in Accounts and signing in.
What works on GitHub#
- Every review feature: comments on lines and ranges, suggested changes, replies, resolving threads, reviews with Comment, Approve or Request changes.
- Viewed files sync with GitHub: a file you mark viewed in Revue is viewed on github.com too, and the other way round.
- Pending reviews: if you started a review on github.com and didn't submit it, Revue adds your comments to it and submits it. You can also discard it (Discard your pending review?: its comments are deleted from GitHub without being published).
- Reactions on the description, comments and review summaries.
- Team review requests: pull requests where a team you're in is asked to review count as asked of you (this needs
read:org). - Check logs: a GitHub Actions job's log opens right in Revue.
- Stacked pull requests: GitHub's own stacks show in the pull request. See Stacked pull requests.
- Editing a pull request's title, description, base branch, draft state, reviewers, assignees, labels and milestone.
- Repositories: browse any repository's branches, history, pull requests and code, clone it and open pull requests from its branches. See Repositories and branches.
Links Revue understands#
Paste any of these into Ctrl+K (Cmd+K on macOS), or open them with revue <link>:
https://github.com/owner/repo/pull/123owner/repo#123owner/repo/pull/123
See Links and opening from anywhere for opening them from your browser.
Limits#
Revue works with github.com. GitHub Enterprise Server isn't supported.
GitHub allows each token a number of API requests per hour. Revue goes easy on it: answers GitHub says haven't changed don't count, and pull requests are kept on disk, so they show at once when you start Revue and refresh in the background.
To see how much is left, look at the status bar at the bottom of the window: API requests left shows each account's allowance and when it resets. The bar turns amber below a tenth.
Advanced: what the pull request list asks GitHub
The list is made of GitHub searches, newest first, each with the first screenful or so (search finds the rest):
| Section | Search | Count |
|---|---|---|
| Review requested | is:pr is:open archived:false review-requested:@me | 30 |
| Re-review | is:pr is:open archived:false reviewed-by:@me -author:@me | 30 |
| Yours | is:pr is:open archived:false author:@me | 30 |
| Involved | involves:@me, minus the ones above | 20 |
| Your repositories | Open pull requests of the repositories the searches above found (ignored repositories left out) | 40 |
Archived repositories are left out. These fill the To review, Mine and All in my repos tabs (see The pull request list, tabs and search).
Advanced: GitHub-only features compared
| Feature | GitHub | Bitbucket | Forgejo |
|---|---|---|---|
| Viewed files sync with the website | Yes | Kept in Revue | Kept in Revue |
| Resolve threads | Yes | Yes | Shown only |
| Reactions | Yes | No | Description and comments |
| Pending reviews from the website | Yes | No | No |
| Check logs in Revue | GitHub Actions | No | No |
| Stacked pull requests from the service | Yes | No | No |
| Assignees, labels, milestone | Yes | No | Yes |