Anvil

Docs · Checks

Checks

Checks are the commands that say a change is fit to merge: tests, builds, linters, runs of the whole app. They're defined with the code and run on your own machines.

Defining

# .aide/config.toml
[[checks]]
name = "test"
run  = "go test ./..."

[[checks]]
name = "e2e"
run  = "go test -tags e2e ./e2e/"
on   = ["macos", "linux", "windows"]
required = true

A check with on runs once per platform, each on a machine of that platform. required checks have to pass before a change merges.

Where they run

Checks wait in the same queue as threads and start on a machine with room that has what they need (see Machines). A thread runs its project's checks on its own machine before it opens a change, so most changes arrive green.

anvil checks run e2e --on win-box   # run one yourself, anywhere

When one fails

A failing check's log goes to the thread whose commit broke it. The thread reads it, fixes the cause on its branch, and runs the check again; you hear about it only if it can't, or if fixing it would mean changing what the change does. For a person's change, the failure comes to them, with a thread offered to look into it.

Flaky checks show as flaky: Anvil keeps every run's log, time and machine, and a check that fails and then passes on the same commit is marked, so it gets an issue instead of a retry button.