mdBoard

Updating mdBoard

Updating changes the agent’s contract as well as the binary. Update the binary first, then let the agent reload the runbook before it acts.

Version files

A 1.0 project has:

# mdboard.toml
mdboard = "1.0.00"
schema = 2

It also has a generated MDBOARD file:

# Generated by mdBoard. Do not edit by hand.
version = "1.0.00"
tag = "alpha"
build = "…"
commit = "…"
updated = "…"

mdboard.toml declares the project contract. MDBOARD records the last binary that opened the project and is refreshed automatically.

Update the binary

cargo install --git https://github.com/mdboard-io/mdboard --locked mdboard-cli
# or pull the new container image
mdboard --version

Then ask the agent to reload the contract:

Human: Run `mdboard runbook`, `mdboard context` and `mdboard check`.
       Tell me what changed for this project.

Update the project

  1. Back up the repository or work on a copy.
  2. Confirm mdboard.toml has schema = 2.
  3. Run mdboard check and fix the findings.
  4. Run mdboard render and review BOARD.md / ROADMAP.md.
  5. Ask the agent for a board brief.
  6. Commit the update before opening the next upstream iteration.

The agent can draft the update plan, but a human should review the diff.

Release metadata

RELEASE and the tag workflow are maintained by the mdBoard repository, not by a project board. The project’s MDBOARD metadata records the binary that last opened it.

Offline checks

MDBOARD_OFFLINE=1 skips the release lookup. The local compatibility guard still runs.

Next