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

Guardrails / rust

Cargo dependencies are locked

rust/lockfile-committed@v1

The build commits Cargo.lock, so a rebuild of the same commit resolves the same crate versions.

Idrust/lockfile-committed
Versionv1
Categoryrust
Default severitywarning
Interpreterpython3
Timeout30 seconds
Violations tolerated0
Collectsrust

Collectors

This guardrail gathers nothing itself. It depends on the collectors below, which the CLI runs once per build before any check, and reads what they found out of GUARDRAIL_FACTS. A collector that collects nothing skips this guardrail rather than failing it.

CollectorGathersInputs it is given
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.projectDir

The inputs above are this guardrail's own, passed straight through. Configuring one in buildnote.json changes what is collected, and two guardrails configured the same way share the one collection.

Configuration

json
{
  "guardrails": {
      "failOn": "error",
      "comment": true,
      "checks": [
          {
              "use": "rust/lockfile-committed@v1",
              "severity": "warning",
              "with": {
                  "projectDir": "."
              },
              "exemptions": []
          }
      ]
  }
}

Inputs

InputDescriptionDefaultEnvironment variable
projectDirDirectory holding the project, relative to the directory the CLI runs in..GUARDRAIL_INPUT_PROJECTDIR

How to fix

Commit the lock file Cargo writes beside the manifest:

bash
cargo generate-lockfile
git add Cargo.lock

A bare 1.0.197 is a caret requirement that matches every compatible release, so without a lock file a rebuild resolves whatever the registry serves that day and the binary that shipped is not the one that was reviewed. The lock file pins this build only: Cargo ignores a library's own Cargo.lock when it is depended on, so committing one settles CI rather than anything downstream.

More in rust

  • rust/edition-floor. The package declares a Rust edition rather than falling back to the implied 2015 one, and that edition is no older than the configured floor.
  • rust/no-git-dependencies. No manifest declares a dependency with a git source, so every crate in the build comes from a registry that versions it.
  • rust/version-declared. The build names the Rust toolchain it compiles with, that toolchain is one exact release rather than a moving channel, and it is no older than the configured floor.

All 4 rust guardrails

Buildnote Limited
Registered in England and Wales, Reg: 16140412