Autopilot

Rules that start runs on pushes and new pull requests, and how to ask for a review in a pull request comment.

Autopilot starts runs for you. Each rule watches one repository and starts a run on every push to a branch, or once for each new pull request. For a one-off review, you can also ask from a pull request comment.

Before you start

  • The Admin role. Only Admins can add, change, pause or remove rules. Members can see them. See Roles.
  • The GitHub App. Autopilot works only on repositories V12 reads through the GitHub App. A public repository added without the App cannot use it. See Connect GitHub.
  • Credits. A rule's runs are charged like any other run, and the organization's monthly limit still applies. A run that the balance or the limit cannot cover does not start.

Add a rule

Open Autopilot and click Add a rule.

In Add a repository, pick the repository. A repository that already has rules shows On Autopilot; add another rule to it from its own menu with Add a rule.

Click choose a trigger and pick Every push or New pull requests.

Fill in the trigger's field, described below. Choosing the branch or the audience saves the rule. To stop instead, click Discard (the × at the end of the row).

Every push reviews every push to one branch. Pick it in choose a branch; the repository's default branch is marked DEFAULT. A branch that another push rule on the repository already watches shows In use.

New pull requests reviews each pull request once, when it opens. Choose the audience:

  • trusted authors: pull requests from people who own the repository on GitHub, belong to the organization that owns it, or collaborate on it;
  • anyone: forks and first-time contributors too.

The draft setting starts at drafts excluded, which reviews a draft pull request when it is marked ready. drafts included reviews drafts as they open. Change it before you choose the audience, or edit the rule afterwards. A repository can have one pull request rule.

Attach focuses

A new rule reviews the whole repository, and its row shows Whole repository. To steer its runs with focuses, click Attach a focus on the rule's row and pick one, or pick New focus… to write one. A rule can carry up to 5 focuses from anywhere in the organization. Each time it fires, the rule starts one run that carries every attached focus. The focuses steer what the run looks for; they do not change what it reviews.

Pause, edit or remove a rule

Click a rule's row to change its trigger, branch, audience or draft setting, then press Enter or click Save rule (✓). Press Esc to leave it unchanged.

The Rule actions menu (…) on each row also offers:

  • Pause or Resume;
  • Run now, which starts the rule's run on the latest commit of its branch right away, without showing a price. It works only for push rules, and Members can use it too;
  • Remove rule…, which stops the rule. Runs it already started stay where they are.

Under Repository, the same menu offers Pause all rules (Resume all rules once they are all paused), Open on GitHub and Remove from Autopilot….

Paused rules

A paused rule starts nothing, and the Paused tab lists it. Its row says why:

  • Paused by owner: an Admin paused it. Click Resume to turn it back on.
  • Paused: GitHub access lost: V12 can no longer read the repository. The rule resumes by itself when GitHub grants access again. Check GitHub access opens the GitHub settings.

Ask from a pull request comment

You do not need a rule for this. On a pull request in a repository with the GitHub App, write a new comment that mentions @v12sec, or the V12 app that comments on your pull requests:

@v12sec please check the new withdrawal limit
  • The commenter must be a trusted author: someone who owns the repository on GitHub, belongs to the organization that owns it, or collaborates on it.
  • Only a new comment counts; editing an old one does not.
  • The @ is required. In a comment of up to 8,192 characters, V12 ignores mentions inside quoted replies, code blocks and inline code, and an escaped \@v12sec; in a longer comment, any mention counts.
  • The run reviews the pull request's changes and reads your comment, so you can add instructions after the mention.
  • Closed and merged pull requests are skipped. If a review of the pull request is already queued or running, V12 replies with a link to it instead of starting another.
  • Each request is a paid run.

On this page