Skip to content

Checks and review ​

A code change passes two gates before you see it: the project's own checks, and a review. Both run inside the run, so a pull request that reaches you has already passed them.

flowchart TD
  commit[Pi's commits on the branch]
  checks{Checks from<br/>.no-mistakes.yaml}
  fix[A fixer Pi repairs<br/>what failed]
  failed([The run fails,<br/>no pull request opens])
  review{no-mistakes reviews<br/>the branch}
  auto[no-mistakes fixes<br/>the finding]
  ask[The decider or<br/>you answer it]
  pr([Pull request with green CI])
  commit --> checks
  checks -- red --> fix
  fix -- checks again --> checks
  fix -- red after 3 fixes --> failed
  checks -- green --> review
  review -- auto-fix --> auto
  review -- ask-user --> ask
  auto --> pr
  ask --> pr

The checks &ZeroWidthSpace;

The project names its checks in a .no-mistakes.yaml file at its root, under commands. Orc runs them in the run's copy after Pi finishes. When a check fails, orc starts a fixer Pi with the failing output, then runs the checks again. After 3 fix attempts with a check still red, the run ends failed and no pull request opens.

The review &ZeroWidthSpace;

On a no-mistakes run, orc hands the checked branch to no-mistakes with the task as its intent. No-mistakes reviews the branch, pushes it, opens the pull request and reports when CI is green. At each of its gates orc answers for you where it safely can.

Finding markedWhat orc does
auto-fixAsks no-mistakes to fix it
no-opIgnores it
ask-userTreats it as a question, and waits for an answer

A run with an open question waits at the gate for 30 minutes. An answer in that time carries the run on at the same gate. With no answer, the task parks on its branch, and the beat resumes it on the same machine once every question has an answer.

The delivery modes &ZeroWidthSpace;

A project's mode in projects.json decides how its ship tasks end.

ModeHow a ship task ends
no-mistakes, the defaultChecks, then the no-mistakes review, then a pull request with green CI
direct-PRChecks, then orc pushes the branch and opens the pull request itself
no-mistakes-prod-onlydirect-PR for a task marked internal, no-mistakes for the rest