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

Guardrails

security

4 guardrails, all at version v1.

GuardrailDefault severityWhat it checks
security/finding-budgetwarningThe number of findings at or above a severity sits within the budget the team set, so a report nobody can read does not pass for a clean one.
security/fixable-vulnerabilitieswarningEvery finding the scanner reported a fixed version for is taken, so the ones that cost an upgrade rather than a redesign are not the ones left open.
security/no-high-findingserrorEvery finding the scanner reported sits below the severity the team gates on.
security/scan-results-presenterrorA scanner ran and left a report the build can be judged on, rather than the build reporting nothing at all.

Shared collectors

Every security guardrail is handed the facts these collectors gather, and each one may ask for more of its own.

CollectorGathers
scanFindings from whatever scanner the build already ran, read from the report it left behind and normalized into one shape, whether the tool was a SAST, an SCA, a secret detector or an infrastructure scanner.

Every guardrail in this category is configured the same way, in the guardrails.checks array of buildnote.json. See Configuring guardrails for every option, and Guardrails to search the whole library.

Buildnote Limited
Registered in England and Wales, Reg: 16140412