elixir
3 guardrails, all at version v1.
| Guardrail | Default severity | What it checks |
|---|---|---|
elixir/lockfile-committed | warning | The project commits mix.lock, so fetching the same commit resolves the same packages and verifies them. |
elixir/no-git-dependencies | warning | No dependency the project declares is fetched from a git repository. |
elixir/version-declared | warning | The project declares the Elixir version it compiles against, and that version is no older than the configured floor. |
Shared inputs
Every elixir guardrail declares these inputs. Individual guardrails can add their own.
| Input | Description | Default |
|---|---|---|
projectDir | Directory holding the project, relative to the directory the CLI runs in. | . |
Shared collectors
Every elixir guardrail receives the facts these collectors gather. Individual guardrails can ask for more collectors of their own.
| Collector | Gathers |
|---|---|
elixir | The Mix build in the project directory: the application it declares, the Elixir version it asks for, every application of an umbrella, the dependencies each manifest names with their environments and origins, and the lock file beside them. mix.exs is Elixir rather than a declaration, so what it declares conditionally is not seen and scanned says so. |
You configure every guardrail in this category the same way, in the guardrails.checks array of buildnote.json. Configuring guardrails lists every option, and Guardrails lets you search the whole library.