Steers

Write down once what reviews should look for, then attach it to runs and Autopilot rules.

A Steer is a short document that guides reviews: what to look for and what to leave alone. It belongs to the whole organization, so you can attach it to a run or an Autopilot rule on any repository. A Steer never picks repositories or narrows what a run reads: the run's own repositories and scope apply.

Admins and Members can both create and edit Steers.

What a Steer holds

  • A name and an emoji. Until you pick an emoji, V12 suggests one from the name.
  • A document: free text in Markdown. Type @ to reference a file, folder, repository, branch, commit, pull request, finding, run, Steer or document. Drop or paste a file to attach it; a pasted link stays in the Steer. Runs read the attached files, and a code review also reads the pages the links point to.

Create a Steer

Open Steers and click New Steer, or press C. A card opens. An organization without Steers finds the card on the Steers page itself.

Enter a Steer name, then press Enter and write the document.

Click Create Steer. The Steer's page opens.

Create Steer waits for a name, and for every attached file to be readable. Close (×) or Esc puts the card away and keeps what you wrote until you reload the page. Open as a page continues the same draft on a full page.

You can also write a Steer where you need it:

  • In the run sheet, Add saved Steer → New Steer… creates a Steer and attaches it to the run. Save as Steer turns the run's instructions into a Steer and attaches it in their place. See Review code or a change.
  • In Autopilot, Attach a Steer → New Steer… on a rule opens the card with Create and attach, which creates the Steer and attaches it to that rule. Only Admins can change rules.

Edit a Steer

Open the Steer from the Steers page. Its Document tab is the Steer itself: change the name, the emoji or the document, and V12 saves as you write. Beside the tabs, Saving… and Saved say where it stands. A blank name is never saved; the page says Name the Steer to save. until you enter one.

Each change to the document makes a new revision. Renaming the Steer or changing its emoji does not. A run keeps every Steer document as it was when the run started, so later edits never change a run that has already started.

A Steer's address, /<organization>/steers/<slug>, comes from its first name and stays the same when you rename the Steer. The API and the CLI name the Steer by that slug too.

The panel beside the document shows:

  • Autopilot: the rules the Steer is attached to; click one to open its repository's Autopilot. Admins can Add to a rule, which searches every rule the Steer is not on, or detach it from a rule with ⋯ → Detach. A rule that already carries 5 Steers is listed as Full.
  • Recent runs: the latest runs that carried the Steer, and All runs.
  • Findings: how many of its findings are open.
  • History: when the Steer was created, and its current revision.

The Findings tab lists the Steer's findings, and the Runs tab lists the runs that carried it. A finding counts under every Steer of the run that found it.

Run with a Steer

Click Run now on the Steer's page. The run sheet opens with the Steer attached; in a repository workspace, it starts on that repository. Pick what to review as for any run, then check the price and start the run as described in Approve the price.

Attach Steers to runs and rules

  • A run carries up to 5 Steers, beside its own instructions; Follow a run says how its page shows them.
  • An Autopilot rule carries up to 5 Steers. Each run the rule starts carries all of them; see Attach Steers.

On this page