Validate a draft .proofline.yaml before committing it

Open Settings → Config file in the repository to test a version 2 YAML draft and correct validation errors before sending it through your normal GitHub workflow.

Validate a draft#

  1. Select Validate a draft config file on the repository's Config file page.
  2. Enter or paste the YAML into Draft YAML in the modal.
  3. Select Validate draft and correct the reported errors at their line numbers. Unknown-field errors list the supported keys.
  4. Read any note under the result. A file that still has the retired effort key is valid, and the note says the key is ignored. Proofline chooses each review's depth, and the deep review command raises it for one pull request.
  5. Close the modal when you finish.

After validating the draft, commit it through your normal GitHub workflow. Validation checks the configuration but does not save it to the repository.

Search help

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