magus v0.4.3 is out. See what's new
¶ View markdown source · ✎ Suggest an edit
1 min read

unknown-env

An advisory by default: it explains, and blocks nothing, on a retired or misspelled MAGUS_* variable handed to a command.

What it catches

A retired or misspelled MAGUS_* variable handed to a command.

Why

A retired or misspelled name is ignored without a word, so the setting the caller meant never takes effect and nothing says so. It fires on the names a command's environment receives: a NAME=value prefix, env NAME=value, env -u NAME, and export. It asks config.EnvVarProblem, the check magus's own startup refuses on (MGS1046), so a name the guard denies is one the binary would refuse, and one it cannot prove wrong passes both.

Default and override

By default this rule takes the decision advise. A workspace sets it by name, in its root magusfile, to deny, advise or off:

magus\guard.builtins({"unknown-env": "deny"})

A loosening takes effect once it is committed; a tightening applies at once.

Seeing it

A verdict names its rule in brackets, which is how you got here:

advise [unknown-env]: ...

magus describe rule unknown-env prints the same entry at a terminal, and magus describe rules lists every rule this workspace enforces.

See also

guardrulesunknown-envadvise
Last updated (1a76274f)
Earlier changes on this page (1)

Full history ↗ · Blame source ↗

Glossary

Workspace

The magus root directory that owns a set of projects and shared config; the unit magus operates over. See workspace.

Magusfile

The magusfile.buzz that declares a project's targets (as export funs) and binds its spells. See targets.

Spell

A language/runtime adapter (e.g. go, md) that maps generic targets onto a toolchain's real commands. See spells.

Buzz

The language magusfiles are written in (the .buzz engine). See engines.

CI

An ordinary magusfile-defined target you compose yourself with magus\needs: magus does not hardcode its stages. Magus.RunCI treats it specially only in that it strips the rw charm, it is the anchor magus affected ci keys off, and a selected scope with no project declaring it is a load error rather than a silent no-op. See targets.

Advisor

One read-only check from the advice suite: it reads the changeset through magus and writes one titled section of findings. The same advisors run as a pull request comment in CI and inside magus diff --impact locally.

Conventions

This page uses none of the site's convention markers. The full set is on the conventions page.