Skip to content
BETAGuardrails are in beta. The library, the configuration format and the CLI command can still change.

buildnote guardrails

Runs the guardrails configured in buildnote.json

Usage

buildnote guardrails <options>

Options

--timeout

Maximum timeout (in seconds) to wait for collection job to finish. If not set, the event collection will return immediately.

Values: int


--org

Organisation identifier

Values: value


--project

Project identifier

Values: value


--module

Module identifier

Values: value


--build

Build identifier

Values: value


--sha

Commit SHA associated with the upload (e.g: 58e53b26ced5fffc72ba5427535e7b5867950b13

Values: value


--ref

Commit Ref associated with the upload (e.g:refs/heads/main)

Values: value


--only

Run only the guardrail with this id. Repeat the option to run several.

Values: value


--fail-on

Severity that fails the build: error (default), warning or never. Replaces guardrails.failOn.

Values: (error|warning|never)


--comment

Post the verdicts as a pull request comment. Replaces guardrails.comment.

Values: [true|false]


--github-token

GitHub token used to post the pull request comment. Replaces report.github.token.

Values: text


--dry-run

Print the verdicts without submitting any event. A dry run never fails the build.


-h, --help

Show this message and exit


Buildnote Limited
Registered in England and Wales, Reg: 16140412