Skip to content

Guardrails

rust ​

4 guardrails, all at version v1.

GuardrailDefault severityWhat it checks
rust/edition-floorwarningThe package declares a Rust edition instead of falling back to the implied 2015 edition, and that edition is no older than the configured floor.
rust/lockfile-committedwarningThe build commits Cargo.lock, so a rebuild of the same commit resolves the same crate versions.
rust/no-git-dependencieswarningNo manifest declares a dependency with a git source, so every crate in the build comes from a registry that versions it.
rust/version-declaredwarningThe build names the Rust toolchain it compiles with. The toolchain is an exact release, not a moving channel, and it is no older than the configured floor.

Shared inputs ​

Every rust guardrail declares these inputs. Individual guardrails can add their own.

InputDescriptionDefault
projectDirDirectory holding the project, relative to the directory the CLI runs in..

Shared collectors ​

Every rust guardrail receives the facts these collectors gather. Individual guardrails can ask for more collectors of their own.

CollectorGathers
rustThe Cargo build in the project directory: the crate it declares, the Rust version and edition it asks for, every workspace member, the dependencies each manifest names with where each comes from and whether it is pinned, and the lock file beside them.

You configure every guardrail in this category the same way, in the guardrails.checks array of buildnote.json. Configuring guardrails lists every option, and Guardrails lets you search the whole library.

Buildnote Limited
Registered in England and Wales, Reg: 16140412