elixir
3 guardrails, all at version v1.
| Guardrail | Default severity | What it checks |
|---|---|---|
elixir/lockfile-committed | warning | The project commits mix.lock, so a fetch of 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 is compiled against, and that version is no older than the configured floor. |
Shared inputs
Every elixir 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 elixir guardrail is handed the facts these collectors gather, and each one may ask for more of its 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. |
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.