Start and follow a run
Start a run on code or a change, approve its price, and follow it to the findings.
A run reviews code in your repositories, or one change, and its findings go to the inbox. Every member of an organization can start and cancel runs, and each run is paid for with credit: see What a run costs.
Start a run
Open the run sheet from any of these places:
- New run on Runs, and on Findings when the switcher shows All repositories.
- Run… on a repository workspace. The sheet starts on that repository.
- Run now on a repository's page, under its name, or in its Findings while nothing has been found at the revision you are viewing. The sheet starts on that repository, at that revision from Findings.
- Run now in the organization's Findings while nothing has been found in any repository. The sheet asks which repository.
- Run now on a Steer. The sheet starts with that Steer attached; see Run with a Steer.
V12 runs only repositories it can reach on GitHub. An archived repository cannot be run.
Review code or a change
The sheet asks one question at a time and lists your answers as it goes. Click an answer to change it.
Which repository? Pick one from the list, or type in Search, or paste a GitHub link. To run a repository the workspace doesn't have yet, paste its GitHub link and press Enter: V12 adds it, then asks the next question.
What should it review? Choose The code to review a branch or a commit, or A change to review a pull request or a branch's new commits.
For The code, answer Which branch?. Open a branch to pick one of its commits instead (Which commit?). If V12 hasn't imported the repository's history yet, choose Use main as it is now, named after the default branch: the run reads that branch when it starts, and V12 imports the history when the run finishes. Then answer What should the run read?: tick up to 200 folders and files, or tick nothing to read the whole repository.
For A change, answer Which change? with an open pull request or a branch. Pick a branch to review its commits since it left the default branch, or open it to choose the first commit yourself (Since which commit?). The diff then shows what the run will review.
What should it look for? is optional. Describe what matters to you, type @ to reference a finding, document, file, commit or repository, or attach documents: drop or paste a PDF, Markdown, text, JSON, DOCX or CSV file anywhere on the box. Each document shows its upload, then its parsing, and the sheet waits until it is readable. A document V12 cannot read says why, for example a scanned PDF with no text; remove it to continue.
Above the text, Add saved Steer attaches a saved Steer, up to 5; New Steer… at the end of its list writes one. Save as Steer turns what you wrote into a Steer and attaches it in place of your words. A Steer guides the run beside your words; it does not change the repositories or scope the run reads.
A code review can read more than one repository. Add a repository adds another one, with its own branch and scope, up to 9 in all.
Approve the price
The last question, Ready, shows four figures for the whole run:
- Files and Lines it will read (Changed lines for a change);
- Estimate, the price of the run;
- Left, the credit your workspace holds now.
For a code review, Ready also offers Detect and triage only. The run then scans and triages, but writes no proofs of concept or fixes, and it costs less: ticking it updates the Estimate. On the run page, Prove and fix reads Skipped.
Click Run to start the run, and its page opens. Save draft keeps the plan instead; see Drafts.
Run and Save draft become available once the price is in. They stay unavailable while a document is uploading or failed, while nothing in scope can be reviewed, or while a repository in the run is not accessible.
If V12 refuses the start for lack of credit, the message links to Settings → Billing:
- "Insufficient credit balance." comes with Add credit; see Add credit.
- "Monthly spending limit reached." comes with Raise the limit; see Monthly limit.
Drafts
A draft is a run that is not started and not charged. Only you see your drafts in Runs, marked Draft.
- Resume reopens the sheet on the saved answers, so you can check them against the latest code and start the run.
- Discard removes the draft.
Only whoever saved a draft, or an Admin, can resume or discard it.
Follow a run
The run page and Runs show where each run is: Queued, then the stage it is working on, then Complete, Failed or Cancelled.
While any run is queued or working, Runs in the sidebar shows how many. In a repository workspace it counts the runs that read that repository.
The progress rail on the run page shows each stage:
- a code review: Queue, Compile, Scan, Triage, Prove and fix, Report and Inbox;
- a change: Queue, Compile, Review changes, Triage and Inbox.
A code review's Compile stage also covers the knowledge-base work that comes before compiling: excluding non-product paths, resyncing components and composing context.
The run page's header links every Steer the run carried. Below it, the page shows each Steer's document as the run read it, then the run's own words under Steering.
Cancel stops a run that is queued or working. A change review that is already working stops at its next checkpoint and shows Cancelling until then.
Refunds:
- a run that fails is refunded in full;
- a run cancelled before it started is refunded in full.
On a failed run, Retry starts the same run again as a new run. Only whoever started the run, or an Admin, sees it.
After the run
When a run completes, V12 imports its findings into the inbox, and the run page lists them under Findings.
- If the page shows Import findings, click it to add the run's findings to the inbox. If the import fails, Retry appears.
- If the run's repository isn't in the workspace, its findings wait for it. Add repository adds it: a public repository for Admins and Members, a private one V12's GitHub App has access to for an Admin. Otherwise an Admin gets Manage GitHub access ↗ and a Member Review repositories, both opening the GitHub section of Settings → Repositories. Adding doesn't import: click Import findings once it's added. The run's row in Runs has the same buttons.
- Findings that did not reach the inbox can be downloaded; see Export run findings.
- Share creates a link to a read-only report of the run, and Stop sharing turns it off; see Share a run report.
- Share also makes guest links that open the run's findings to people outside your organization; see Share a run with guest links.