Build¶
What comes out of this repository: five server images and a Helm chart for a cluster;
troupe-daemon, troupe and the desktop app for a machine; and a few generated files
that are committed.
1. The server images¶
docker/Dockerfile builds all four umbrella releases; RELEASE picks which (default
troupe_operator). Two stages:
- build, on
hexpm/elixir(Elixir, OTP and Debian versions as build arguments): dependencies are fetched from themix.exsfiles first so the layer caches, thenconfig/andapps/are copied andmix release ${RELEASE}runs. ForRELEASE=troupe_workerit installs a pinned Zig somix compile.reapercan build the two Linuxreapers, and then fails the build if the release has no*-linux-musl/reaper— without it the image starts and answers everyshellcall with:reaper_missing, a failure that only ever shows in a pod. - runtime, on Debian slim: uid/gid 1000 (what the operator's pod spec asks for), the
release, and
ENTRYPOINT exec /app/bin/${RELEASE_NAME} startso a SIGTERM becomes a graceful stop.git,bubblewrapandinotify-toolsare installed for the worker image only: a sandbox helper and a network client are the last things to want in the internet-facing plane or the operator that holds cluster privileges, andinotifywaitis what lets a pod report a deleted file at all (the polling fallback never does). Ports and probes are the chart's business.
.dockerignore keeps out clients/, docs/, tests, _build, deps and a laptop's
priv/reaper (the wrong architecture with the right name). The fifth image, troupe-gui,
is built from clients/gui as its own context.
scripts/build-images # all five, tagged dev, loaded into kind if troupe-dev exists
scripts/build-images troupe_worker # a subset
TROUPE_REGISTRY=registry.example.com/troupe TROUPE_IMAGE_TAG=0.15.0-beta TROUPE_PUSH=true scripts/build-images
Images are linux/amd64 explicitly, so a non-amd64 laptop does not build one the node
pool cannot run. A rebuilt image under an unchanged tag changes nothing in a pod spec:
scripts/remote-up follows the build with kubectl rollout restart.
2. The machines' builds¶
All on native runners in .github/workflows/native.yml (CI):
troupe-daemon:MIX_ENV=prod mix release troupe_daemoninapps/troupe_daemon, a tarball per target, with the host'sreaperinside.troupe, the TUI: a Burrito binary per target fromclients/tui(clients/tui/scripts/build-localfor this host). Linux targets link musl.- The desktop app: Tauri, from
clients/gui/apps/desktop:.dmg,.exe/.msi,.deb/.rpm/.AppImage, unsigned until the signing secrets exist (install.md).
The VS Code extension is troupe.vsix: pnpm package in clients/vscode builds it with
vsce, CI keeps the one it builds as the run's artifact, and a release or pre-release
attaches its own, which the installers' --vscode (-VSCode) installs. It is on no
marketplace (vscode.md).
install.sh and install.ps1 at the root install troupe-daemon, and on request troupe,
the desktop app and the VS Code extension, from a release, and check them against its
SHA256SUMS and, where minisign is installed, the signed manifest.json (Decision 865). On this Windows machine,
scripts/setup-windows-toolchain.ps1 and scripts/install-local.ps1 build and install
from a checkout.
The reaper¶
mix compile.reaper is a compiler appended to troupe_core's: it runs zig build-exe
native/reaper/reaper.zig (under apps/troupe_core) into
apps/troupe_core/priv/reaper/<triple>/, for the host triple by default, every triple
with TROUPE_REAPER_TARGETS=all, or a comma-separated list. Without Zig it warns and
skips, and shell does not run. A release sets the two Linux triples.
3. Generated, committed files¶
| Generated | Written by | Checked in CI by |
|---|---|---|
protocol/schema/v1/** |
mix troupe.schema.gen from Troupe.Protocol.Schema |
mix troupe.schema.diff (add-only), then regenerate and git diff --exit-code |
apps/troupe_plane/priv/static/theme.css |
mix troupe.theme (Signal by default), from clients/gui/docs/design/themes/*.tokens.json |
--check |
apps/troupe_plane/priv/static/brand/{favicon.ico,apple-touch-icon.png} |
python scripts/brand-icons.py (Pillow), when the mark changes |
a test that they exist |
protocol/schema/config/v1.json, and docs/user/configuration.md between its markers |
mix troupe.config.schema, from the key table in Troupe.Config.Schema the loader validates against |
--check, in the lint job, dev-check and scripts/ci |
PROTOCOL.md §9, the admin method table between its markers |
mix troupe.admin.reference, from the methods Troupe.Plane.Admin.API declares (name, role, risk, arguments, summary) |
--check, in the lint job, dev-check and scripts/ci, and a plane test |
docs/egress-allowlist.md |
mix troupe.egress, from what each component declares it dials |
a test that it is current |
docs/third-party-licences.md, THIRD-PARTY-NOTICES.txt, charts/troupe/{LICENSE,NOTICE} |
elixir scripts/licences.exs, from the two Mix locks, the two pnpm workspaces (clients/gui, clients/vscode) and the Cargo locks (the desktop app's and ex_ratatui's), once their packages are fetched: the inventory, the licence texts the shipped packages carry, and the chart's copies of the root's |
--check in licences.yml, which also refuses a licence outside the script's policy |
clients/gui/apps/desktop/src/{tokens.css,mark.ts} |
pnpm tokens, from clients/gui/docs/design/themes/*.tokens.json |
pnpm tokens:check |
clients/tui/lib/troupe/ui/tui/palette.ex |
mix troupe.palette in clients/tui, from every clients/gui/docs/design/themes/*.tokens.json: the TUI's colours by role in each theme, with their xterm-256 and sixteen-colour stand-ins, and the mask in two cuts (Decision 716) |
--check, in the TUI's mix check |
docs/user/cli-reference.md, between its markers |
mix troupe.cli.reference in clients/tui, from the command lines beside the parser (Troupe.CLI.commands/0) and the harness's slash commands (Troupe.Commands), the two tables troupe --help prints (Decision 767) |
--check, in the TUI's mix check and in dev-check |
clients/gui/apps/desktop/src-tauri/icons/* |
pnpm icons, from mark.ts and the Signal tokens: every icon the bundler wants, the NSIS images and the dmg background (Decision 703) |
pnpm icons:check, on the pixels |
test/fixtures/logs/<version>/ |
mix troupe.fixtures.record <version>, meant for every release, though only 0.2.0 and 0.3.0 have been recorded; refuses to overwrite |
fold_test.exs replays every version |
There is no npm or esbuild in the umbrella: the plane serves no JavaScript of its own
beyond the front page's, and the console is built in clients/gui.
4. Version¶
VERSION is the version of everything this repository releases (Decision 668): the
umbrella's apps and the daemon read it, and so does the TUI. The chart, the GUI's
packages and the desktop app cannot, and carry a copy that elixir scripts/version.exs
check compares (CI's versions job) and elixir scripts/version.exs set <version>
writes. The desktop app gets the version without its pre-release part, because WiX
refuses a non-numeric one. A release is a merged change to VERSION
(deployment.md).
Mix writes an app's .app, where its version is compiled, again only when mix.exs or the
config changed, so every project that reads VERSION lists troupe_protocol's
:troupe_version compiler after :app (compilers: Mix.compilers() ++ [:troupe_version]).
It has :app write the .app again when its version is not VERSION's, which is what makes
a checkout that built the previous release build the new one (Decision 768). A new
mix.exs that reads VERSION lists it too.