A release is one GitHub release, muster-v<version>, carrying two ways to run Muster. People pick one:
| Asset | For whom | What it is |
|---|---|---|
Muster-<version>-Basecamp-<tag>-linux-x86_64.AppImage |
someone who wants to download one file and run it | Basecamp's own released AppImage with Muster and the Logos Official modules it needs already installed inside. chmod +x, run, click Muster. |
muster_module-<version>-linux-amd64.lgx, muster_ui-<version>-linux-amd64.lgx, and lez_msig_module-<its version>-linux-amd64.lgx, the private LEZ multisig's prover (optional; since 0.3.3) (or muster_module-<version>.lgx, muster_ui-<version>.lgx, one per package holding every platform, from --from-run) |
someone who already runs Basecamp, or logoscore |
the two portable packages. Basecamp installs them from Muster's catalogue (catalog/, docs/runbooks/install-from-catalogue.md) and fetches the dependencies from Logos Official; lgpm install --file installs them by hand. |
Both are built from the same commit, and the AppImage contains exactly the two .lgx files the release publishes.
-
Version. Bump
"version"inmodule/metadata.jsonandui/metadata.json(both the same), merge it, and update a clean localmain. -
Green.
module/tests/run-suite.shandscripts/ui-parity.sh(MUSTER_FLEET=localneeds no fleet; the split test needs foundry onPATH, e.g.nix shell nixpkgs#foundry). -
The packages and the catalogue.
scripts/catalog-release.sh. The release targets this commit, so it must be on GitHub.- Every platform by default (exo-04f).
muster_moduleandmuster_uicome from thelgx variantsworkflow's build of this commit:linux-amd64,linux-arm64anddarwin-arm64, merged into one.lgxper package (docs/design/platforms.md). When no run built this commit, the script dispatches one on its branch and waits for it (about 20 minutes).--from-run <id>names a run. lez_msig_moduleis built here, forlinux-amd64only.- Output. Everything goes into
.run/catalog-release/muster-v<version>/, and the script writescatalog/index.jsonandcatalog/icons/. --herebuilds the two packages on this machine, for its platform only.
- Every platform by default (exo-04f).
-
The AppImage, from those same files.
scripts/release-appimage.sh --lgx-dir .run/catalog-release/muster-v<version>
It downloads the Basecamp release named in
infra/basecamp/release-<tag>.envand checks its sha256. It then installs the two.lgxfiles and the Logos Official packages pinned ininfra/basecamp/bundle-<tag>.tsv, each checked against its sha256, into the release's built-in module and plugin directories, with thelgpmthat release links. Finally it repacks the image behind the release's own AppImage runtime, as.run/appimage/Muster-<version>-Basecamp-<tag>-linux-x86_64.AppImage. -
Look at it. Run it with a fresh profile, on a display or under Xvfb:
.run/appimage/Muster-*.AppImage --user-dir "$(mktemp -d)"
✓ Muster is in Basecamp's app list with nothing to install. Launch it: Needs you renders, Start something opens a room, and the log has
Successfully loaded UI module: muster_uiand nomuster_uiQML errors.APPIMAGE_EXTRACT_AND_RUN=1avoids needing FUSE. -
Publish. This is outward-facing: it puts binaries on the public repo.
gh release create muster-v<version> --target <commit> --title "Muster <version>" --notes-file <notes> \ .run/catalog-release/muster-v<version>/*.lgx \ .run/appimage/Muster-<version>-Basecamp-<tag>-linux-x86_64.AppImage
-
Catalogue. Commit
catalog/index.jsonandcatalog/icons/tomainonly after the assets are up, because Basecamp offers whatever the index names.
Add infra/basecamp/release-<tag>.env (the AppImage URL and sha256, the design-system rev, and the lgpm rev from that release's flake.lock). Add infra/basecamp/bundle-<tag>.tsv: the dependencies Basecamp's Package Manager would install for Muster from the Logos Official index, closed over their own dependencies, each with its sha256. Then point scripts/release-appimage.sh and scripts/ui-lint.sh at the new env file.
- What is checked where. The AppImage was run on the build machine (bugger), with a fresh profile under Xvfb. Its portability is Basecamp's: Muster adds only portable packages, the same ones a catalogue install puts in a profile.
- Updating inside the AppImage. The baked-in Muster is part of the image. A newer Muster from the catalogue installs into the profile beside it; to move a person to a new Muster, ship a new AppImage.
- Retired: the
v0.1.0-demoandv0.2.0-demoAppImages were built from a local Basecamp checkout with uncommitted bake-in edits (make appimage). They cannot share a room with today's builds.