scala
4 guardrails, all at version v1.
| Guardrail | Default severity | What it checks |
|---|---|---|
scala/dependencies-pinned | warning | 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. |
scala/no-snapshot-dependencies | error | 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 | warning | 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 | warning | The build declares the Scala version it compiles against, and that version is no older than the configured floor. |
Shared inputs
Every scala guardrail declares these inputs, and each one may add its own.
| Input | Description | Default |
|---|---|---|
projectDir | Directory holding the project, relative to the directory the CLI runs in. | . |
Shared collectors
Every scala guardrail is handed the facts these collectors gather, and each one may ask for more of its own.
| Collector | Gathers |
|---|---|
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. |
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.