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

Magusfile diagnostics

Codes in the MGS1xxx range flag problems with how a workspace's magusfile(s) are authored: targets that must exist but don't, declarations that do not resolve, and similar. Magus raises them at run time (as a typed DiagnosticError) and, where applicable, as a magus doctor health check so the gap is visible before CI runs.

Codes

  • MGS1001: no ci target defined in the selected project(s).
  • MGS1002: a spell import is shadowed by a same-named spell higher in the tree.
  • MGS1049: a target runs a script a manifest defines, hiding its steps from the cache key.
  • MGS1050: a queue.carry_approvals entry in magus.yaml names no tier, or names code.
  • MGS1051: a spell's mgs_ functions do not match the spell contract, so it does not load.
  • MGS1052: a magus\job.modelTiers or magus\job.modelTier call names tiers, a default, a harness or a matrix magus cannot use.
magusfilediagnosticserror codesMGS1xxxtargetsdoctorauthoring
Last updated (29d8b3de)
Earlier changes on this page (5)

Full history ↗ · Blame source ↗

Glossary

Workspace

The magus root directory that owns a set of projects and shared config; the unit magus operates over. Workspace in full.

Project

A directory magus recognizes as a unit of work (it has a magusfile); the unit of caching, scheduling, and dependency tracking. Project in full.

Magusfile

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

Target

A named operation (build, test, ...) you invoke with magus run <target>; it may compose a spell's tool-native operations and depend on other targets. Target in full.

Spell

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

Manifest

The file that declares what a package is: its name, dependencies, entry points and tool config (go.mod, package.json, pyproject.toml, Cargo.toml). How the workspace builds, tests and lints the package belongs in the magusfile, not in the manifest's scripts. Manifest in full.

Cache

The content-addressed store magus consults before running a target, so unchanged work is skipped. Cache in full.

CI

An ordinary target you compose yourself with ctx.needs; magus does not hardcode its stages. It is the anchor magus affected ci keys off, and ci strips the rw charm. CI in full.

Health

The at-a-glance daemon state derived from the pool: healthy when the pool is reporting, degraded when it reports an error, down when there is no pool. The dashboard color-codes each state. Health in full.

Harness

The deterministic scaffolding around the work on a change, for a person or an agent: compiler errors, formatters, linters, checks, gates, leases and hooks, placed at points a person chose. Around an agent's loop, magus supplies one and keeps it outside. Harness in full.

Job

The unit of delegated work, and one row of the job store: what an orchestrating agent handed out, with its goal, the checkpoint it was cut against, the paths it may write or must not touch, and the one check it runs. A job's holder is either a session, for work an orchestrator handed out, or the daemon, for its own maintenance. The store records; the agent guard is what reads those facts back when grading a write. Job in full.

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. Run in full.

Conventions

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