Skip to content

Guardrails / dotnet

Package references carry a version ​

dotnet/dependencies-versioned@v1

Every PackageReference names its own version or takes one from a central PackageVersion.

Iddotnet/dependencies-versioned
Versionv1
Categorydotnet
Default severityerror
Interpreterpython3
Timeout30 seconds
Violations tolerated0
Collectsdotnet

Collectors ​

This guardrail doesn't gather anything itself. It relies on the collectors below, which the CLI runs once per build before any check, and reads what they found from GUARDRAIL_FACTS. If a collector collects nothing, this guardrail is skipped, not failed.

CollectorGathersInputs it is given
dotnetThe .NET build in the project directory: the SDK it pins, every project file and the frameworks each targets, the packages they reference and which of them are pinned or supplied centrally, and the lock files beside them.projectDir

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

Configuration ​

json
{
  "guardrails": {
      "failOn": "error",
      "checks": [
          {
              "use": "dotnet/dependencies-versioned@v1",
              "severity": "error",
              "with": {
                  "projectDir": "."
              },
              "exemptions": []
          }
      ]
  }
}

Inputs ​

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

How to fix ​

Give the reference a version, or add a central PackageVersion for it to take one from:

xml
<PackageReference Include="Serilog" Version="4.0.0" />
xml
<PackageVersion Include="Serilog" Version="4.0.0" />

A PackageReference with no version of its own and no central one restores whatever NuGet picks, so the package the build compiles against is chosen at restore time, not in the commit.

More in dotnet ​

  • dotnet/central-package-management. A single Directory.Packages.props sets the version of every package, instead of each project file setting its own.
  • dotnet/sdk-pinned. global.json names the SDK the build uses and holds it there, so a newer SDK on the runner can't take over.
  • dotnet/target-framework-floor. Every net<major>.<minor> framework a project targets is no older than the configured floor.

All 4 dotnet guardrails

Buildnote Limited
Registered in England and Wales, Reg: 16140412