Axon Shaft docs

Skipping a pull request

Skip labels, the Code review's filters, paths to leave out, and pausing a project, with how to review a skipped pull request anyway.

Each way of skipping ends the run with a notice in the job's annotations. Someone with write access can review a skipped pull request by commenting /review, except on a paused project.

Skip labels

A pull request with one of the Code review's skip labels isn't reviewed when it's opened, pushed to or marked ready. The run ends with skip_label.

  • Every project starts with skip-review, no-review, skip-ai-review and do-not-review.
  • The labels match whatever their case.
  • Change the list in the Code review automation, under When it runs: Skip pull requests with these labels. Clear it to skip none. See labels.
  • Removing a label doesn't start a review, because the workflow doesn't run on labeled or unlabeled. The next push is reviewed as usual.

Labels are skipped only from action 1.7, which is the first to send them.

Filters

The Code review's Which pull requests settings skip these, each ending with filtered:

SettingSkipsDefault
Axon Shaft's own pull requestsPull requests from axonshaft[bot], such as the one that adds the workflowDon't review them
Pull requests opened by botsPull requests from bot accounts, such as Dependabot and RenovateDon't review them
Outside contributorsAuthors who aren't owners, members or collaborators and can't pushDon't review them
Target branchesPull requests into a branch not on the listEmpty: any branch

The forks setting can hold back a fork's pull request too. See Forks.

When it runs, and turning Code review off

A pull request event that isn't one of the Code review's When it runs choices isn't reviewed. Turning the Code review automation off stops reviews from pull request events. Both end with a notice that has no code.

Paths to leave out

The skip globs leave files out of the review, not whole pull requests. Lockfiles, dist folders, minified files and snapshots are left out by default. When no checklist matches the files that are left, no model is called, and every checklist's check run is skipped.

Pausing a project

Pause Axon Shaft in the project's Settings, under Danger zone. Every run on the repo then ends with paused, commands and /help included, and the project's status reads Paused. Resume undoes it. The account's admin, or someone with the Admin or Maintain role on the repo, can pause and resume, and both are in the audit log.

Turning off one checklist

To stop one kind of check without skipping the pull request, turn that checklist off in the automation, under What it looks for. Its chip shows ➖ and it posts no check run.

Last updated on