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

MGS1038: a magus.project option was removed

A magusfile sets a key that magus.project used to accept:

[error] [MGS1038] magus.project: targets["build"]: option "exclusive" was removed in
v0.5.0 with no replacement; slots and memory_mb are the only concurrency dials, so delete
the key

Why this stops the load instead of ignoring the key

An option magus does not recognize is usually ignored with a warning, because it may come from a NEWER magus: rejecting it would stop the workspace loading, including the command that builds a binary new enough to read it.

A removed option is the opposite case. It came from an OLDER magus, and you are already on the newer one. The ignore path would tell you to upgrade, which sends you in a circle, and meanwhile the value you declared does nothing. Stopping with the key's name and what to do is the only answer that ends the loop.

What to do

Follow the message. Each removed option names its replacement, or says it has none.

option removed in instead
exclusive v0.5.0 nothing: delete the key

exclusive

It asked for a target, or every target in a project, to run with no other target beside it. It was meant for a target that uses the whole machine, and measured across every declaration it never did: most protected nothing, and where the engine honored it, it serialized every other gate member behind one target until the stall watchdog took the run.

slots and memory_mb are the concurrency dials a target has. A target that must not run beside a peer is making a claim about a shared resource, such as a tag namespace or a branch it pushes, and the place to express that is its own CI job rather than a policy on the target. ADR 0001 records the reasoning and the measurement.

MGS1038magusfileoptionsupgraderemovedexclusive
Last updated (79e6c198)
Glossary

Workspace

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

Project

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

Magusfile

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

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. See targets.

Op

A single tool-native command a target composes (long form: operation); the middle of the work hierarchy (Spell to Op to Target). See operations.

Engine

The interpreter a magusfile runs on; magus embeds 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.

Slot

One unit of the pool's capacity. A target acquires the slots it needs to run (most take one) and releases them when it finishes; the pool tracks capacity (total slots), running (acquired), and queued (blocked). See server.

Concurrency

How many targets run at once. It is bounded by the pool's capacity and set with --concurrency, MAGUS_CONCURRENCY, or the concurrency config key. See server.

Invocation

One magus process's recorded facts - the targets it finished, their outcomes, the lease it acted as, and the session it ran in when a host delivered one - kept in a repo-scoped store every worktree shares. magus session lists them; the store prunes itself by last-fact age.

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 server, for its own maintenance. The store records; the agent guard is what reads those facts back when grading a write. See doctrine.

A job is not a run. magus run build web is a run, and no job exists for it. A job causes runs: its check executes as one, and a server job records the invocation of its last one. Jobs are listed with magus ls jobs and in the console's Jobs view; runs are listed in the Runs view.

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.

Conventions

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