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

exit-status-echo

An advisory by default: it explains, and blocks nothing, on a line ending by printing an exit status, which the harness already reports.

What it catches

A line ending by printing an exit status, which the harness already reports.

Why

The harness reports a nonzero exit on its own and success needs no confirmation, so cmd; echo "rc=$?" adds lines and no information. It also misreports: the echo exits 0, so the line as a whole passes whatever cmd did. Every spelling of that ending fires: echo/printf of $? with literal text, to the console or stderr; the same through a capture (rc=$?; echo $rc); cmd || echo "failed $?", where the echo runs exactly when cmd failed; and ${PIPESTATUS[...]}, whose answer is set -o pipefail or no pipe. exit $?, [ $? -ne 0 ], an echo mid-script, one after &&, and one redirected to a file keep the status for later logic and are untouched. Chain with &&, or make separate calls, when a failure must not be masked.

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({"exit-status-echo": "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 [exit-status-echo]: ...

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

See also

guardrulesexit-status-echoadvise
Last updated (1a76274f)
Earlier changes on this page (2)

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.

Run

One target executing under one magus invocation, such as magus run test web or magus affected ci. A run keeps its captured output behind an output reference. Every magus run is a run whether or not any job asked for it; see Job for how the two relate.

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.