Define pull request checks in repository YAML

Version your checks with the repository to review changes to their rules alongside the code they apply to.

Define checks in .proofline.yaml#

A repository can define checks in its .proofline.yaml, with version: 2:

version: 2
checks:
  - slug: conventional-title
    rule: TITLE_PATTERN
    pattern: "^(feat|fix|docs): "
    mode: BLOCKING
  - slug: api-labels
    rule: REQUIRED_LABELS
    required_labels: [api-reviewed]
    path_globs: ["api/**"]
    mode: ADVISORY

A pull request cannot exempt itself by editing or removing a file-defined check. Each review reads the file at the merge base, so the existing checks apply to that pull request. Its configuration change applies to pull requests opened after it merges.

The Checks page lists file checks with their source commit; edit them in the file. Settings-defined checks keep their names, so a file check with the same name is ignored. Define coverage checks in settings.

Search help

Tab to a result. Enter to open. Escape to close.