Add repositories
Every repository Anvil can review is listed in Settings → Repositories, GitHub and hosted together, each with a switch for reviews. Add repositories at the top offers three ways in.
From GitHub #
- In Settings → Repositories, click Install on GitHub.
- Pick your account or an organisation.
- Choose All repositories or Only select repositories, then Install.
GitHub sends you back to Anvil, and the repositories appear in the list within a minute, marked Reviewing. The next pull request gets a review. To add or remove repositories later, open the same link again, or change the installation in GitHub's Settings → Applications.
What the app may do #
| Permission | Why |
|---|---|
| Pull requests, issues: write | Post the walkthrough, inline findings and replies |
| Commit statuses, checks: write | Set the Anvil status |
| Contents, workflows: write | Push the changes people ask for with @anvil fix, and open the pull request that moves workflows to Anvil runners |
| Actions: write | Read runs and logs; re-run and cancel jobs for you and your agents |
| Administration, self-hosted runners: write | Register one-job runners on Anvil for runs-on: anvil-* |
| Organisation members, email addresses: read | See who belongs to an organisation, and match your GitHub sign-in to your Anvil account |
Anvil never pushes to your default branch, and code changes happen only when someone with write access asks. See Let Anvil change code.
Hosted on Anvil #
New repositories have reviews on unless you turn Review pull requests off when you create them (Code → New repository).
For a repository you already have, flip its switch in Settings → Repositories. You need admin rights on the repository; without them the row says Needs admin.
Mirror a GitHub repository #
A mirror copies a GitHub repository onto Anvil and pulls new commits every 10 minutes, with reviews on.
- In Settings → Repositories, click Mirror a repository.
- Paste the clone URL, for example
https://github.com/you/project.git. - For a private repository, add a GitHub token that can read its contents.
- Click Create mirror.
Turn reviews off #
| To stop reviews | Do this |
|---|---|
| For a repository | Flip its switch in Settings → Repositories (GitHub: paused; hosted: the reviewer loses access) |
| In the repository's code | Set enabled: false in .anvil.yaml |
| On one pull request | Comment @anvil pause, and @anvil resume to turn them back on |
| Everywhere on GitHub | Uninstall the app on GitHub |
Statuses in the list #
| Status | Meaning |
|---|---|
| Reviewing | New pull requests and pushes get reviews |
| Paused | Connected, but automatic reviews are off; @anvil review still works |
| Not connected | The app isn't installed there (GitHub), or the reviewer has no access (hosted) |
| CI on Anvil | A CI job ran on Anvil in the last 30 days |