Guardrails / scala

Scala dependencies are pinned

scala/dependencies-pinned@v1

Every library dependency read out of the build names a literal revision. build.sbt is Scala read by pattern, so a dependency built by a function, added inside a condition or held in a variable is not seen and the list is a floor rather than the whole of it.

Id	scala/dependencies-pinned
Version	v1
Category	scala
Default severity	warning
Interpreter	python3
Timeout	30 seconds
Violations tolerated	0
Collects	scala

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.

Collector	Gathers	Inputs it is given
scala	The sbt build in the project directory: the Scala and sbt versions it pins, every subproject the reader saw, the library dependencies each build file names with their configurations, and the plugins the build itself runs. build.sbt is Scala rather than a declaration, so what it declares indirectly is not seen and scanned says so.	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

{
  "guardrails": {
      "failOn": "error",
      "comment": true,
      "checks": [
          {
              "use": "scala/dependencies-pinned@v1",
              "severity": "warning",
              "with": {
                  "projectDir": "."
              },
              "exemptions": []
          }
      ]
  }
}

Inputs

Input	Description	Default	Environment variable
projectDir	Directory holding the project, relative to the directory the CLI runs in.	.	GUARDRAIL_INPUT_PROJECTDIR

How to fix

Write the revision as a literal in the entry that declares it:

libraryDependencies += "org.typelevel" %% "cats-effect" % "3.5.4"

sbt takes a literal revision rather than a range, so an entry that is not one is either a moving revision such as latest.integration, which resolves to whatever the repository serves that day, or a reference this reader cannot follow. build.sbt is Scala read by pattern rather than a build that is evaluated here, so a revision held in a val or produced by a function reads as unresolved too: writing it at the entry is what puts the version in the diff that changes it.

More in scala

• scala/no-snapshot-dependencies. No library dependency read out of the build is a -SNAPSHOT. build.sbt is Scala read by pattern, so the dependencies it declares indirectly are not seen and the list is a floor rather than the whole of it.
• scala/sbt-version-pinned. project/build.properties pins the sbt version the build runs under, rather than leaving it to the launcher the machine happens to carry.
• scala/version-declared. The build declares the Scala version it compiles against, and that version is no older than the configured floor.

All 4 scala guardrails