Guardrails / ruby

Ruby version is declared

ruby/version-declared@v1

The project declares the Ruby version it is built and run against, and that version is no older than the configured floor.

Id	ruby/version-declared
Version	v1
Category	ruby
Default severity	warning
Interpreter	python3
Timeout	30 seconds
Violations tolerated	0
Collects	ruby

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
ruby	The Bundler project in the project directory: the Ruby version it asks for, the gem sources it resolves from, the gems each manifest declares with their groups and origins, and the lock file beside them. The Gemfile is Ruby rather than a declaration, so what it declares conditionally 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": "ruby/version-declared@v1",
              "severity": "warning",
              "with": {
                  "projectDir": ".",
                  "minVersion": "3.0"
              },
              "exemptions": []
          }
      ]
  }
}

Inputs

Input	Description	Default	Environment variable
projectDir	Directory holding the project, relative to the directory the CLI runs in.	.	GUARDRAIL_INPUT_PROJECTDIR
minVersion	Oldest Ruby version accepted. A declared version below this is a violation.	3.0	GUARDRAIL_INPUT_MINVERSION

How to fix

Declare the interpreter where a developer's shell and the deploy tooling already look, in a .ruby-version file naming the exact release, or in the Gemfile beside the gems:

ruby "3.3.1"

Without one the interpreter is whichever Ruby the runner and the deploy image happen to carry, so a syntax or standard library difference is found by production rather than by the laptop that introduced it.

More in ruby

• ruby/lockfile-committed. The project commits Gemfile.lock, so an install of the same commit resolves the same gem versions.
• ruby/no-git-dependencies. No gem the manifests declare is fetched from a git repository rather than from a gem source. The Gemfile is Ruby rather than a declaration and is read by pattern, so a git gem that is found is a real finding, but finding none is not proof that there is none: a gem added inside a condition, a loop or an eval is not seen.
• ruby/single-gem-source. The Gemfile resolves gems from at most one source, and that source is one the repository trusts. The Gemfile is Ruby rather than a declaration and is read by pattern, so a second source that is found is a real finding, but finding one source is not proof that there is only one: a source named inside a condition, a loop or an eval is not seen.

All 4 ruby guardrails