Axon Shaft docs

Check runs

The check runs a review posts, what each conclusion means, and which ones to require in branch protection.

A review posts its check runs on the commit it reviewed. Each name starts with Axon Shaft / .

Check runWhen it's posted
Axon Shaft / reviewEvery review. In progress while it runs, then passed or failed.
Axon Shaft / <checklist>Each checklist the automation keeps on, named by its key.
Axon Shaft / own-<n>Each check the project added itself, numbered by its place.
Axon Shaft / gatesWhen the project has merge gates.

The checklist catalog gives each checklist's exact check run name, such as Axon Shaft / security or Axon Shaft / vulnerabilities.

Conclusions

A checklist's check run follows its chip on the summary card:

Card chipConclusion
❌ A blocking findingfailure
⚠️ Only should-fix or nit findingsneutral
✅ Checked, nothing foundsuccess
⬜ Not checkedskipped
➖ Turned off on the dashboardno check run

A checklist that didn't run is skipped, and its title says why: "No matching files changed", or that this version of the action doesn't have its script. When no checklist runs, every checklist's check run is skipped and no model is called.

Axon Shaft / gates fails when a gate isn't met, or when the review didn't report on one. A gate that doesn't apply passes.

Axon Shaft / review fails when the review fails, with the failure's message and a link to the run.

Which ones to require

Any of them can be a required status check, in a branch protection rule or a ruleset. GitHub counts neutral and skipped as passing, so a required checklist blocks merging only on a blocking finding.

  • Require Axon Shaft / gates to hold merging until every gate is met.
  • Require the checklists whose blocking findings should stop a merge, such as Axon Shaft / security and Axon Shaft / vulnerabilities.
  • Don't require a checklist that's turned off. It posts no check run, so the requirement waits forever.

A run that posts nothing posts no check runs either: a pull request that's skipped by a label or a filter, a project that's paused, or a run that stopped at its spending cap. A required check then shows as expected and waiting. On a pull request that a label or a filter skipped, comment /review to run the review and post them.

The workflow doesn't run on merge_group, so Axon Shaft posts no check runs on a merge queue's commits.

Permission

Check runs need the app's Checks (write) permission on the installation. Until the account's admin approves it, the review still posts its comments, the job log warns once, and no check runs are posted. See Permissions to review.

Older action versions

An action before 1.6 doesn't run checklists. It posts one check run for each of the Code review's checks, such as Axon Shaft / correctness, and Axon Shaft / rules for the project's own checks, only when they found something.

Last updated on