Files
bootvine/docs/development.md
T
Willem Vanhulle 7e95cbd8e9 feat: show why units failed, with their last journal lines
Failed jobs keep their kind: units that broke or timed out get a failure
panel entry with the reason systemd reports (exit status, signal, timeout,
start limit, status text) and their last journal lines read through
libsystemd. Units that failed only through a dependency are dimmed and left
out of the panel, and units that crash after starting count as failed.

Restructure the repository around this:
- move the library and binary into bootvine/ and the scripted demos into
  their own unpublished scripted-demos crate, with their VHS tapes
- move the crane builds and NixOS module into nix/
- group each sample VM with its check under vm-tests/, adding text-console,
  scripted-initrd, encrypted-volume and failures machines and a vm-failures
  check
- add docs/guide.md walking through the screen with every recording, keep
  one recording in the README, and re-render all recordings
2026-10-30 14:59:10 +01:00

5.4 KiB

Development

Layout

Folder Holds
bootvine/ the published crate: the library, the bootvine binary and the unit and initrd files it installs
scripted-demos/ the scripted boot, shutdown and passphrase demos, and the VHS tapes that record them
xtask/ repository tasks run with cargo xtask
vm-tests/ the sample NixOS machines, one folder each with its VM check
nix/ the crane builds and the NixOS module
recordings/ the animations and screenshots the README and the guide show

cargo build and cargo test act on every crate. cargo run needs the binary: --bin bootvine, --bin scripted-boot and so on.

Setup

Work inside the dev shell (direnv allow once, with direnv). Version control is jj, not the git CLI.

Before committing

cargo clippy --workspace --all-targets
cargo fmt --all

Clippy runs with the pedantic lints and forbids absolute paths; formatting needs the nightly toolchain the dev shell provides.

Commit messages follow Conventional Commits. jj does not run git hooks, so check the commits you are about to push with:

nix run .#check-conventional-commits -- origin/main..HEAD

Git users can install the same commit-message check and a formatting check as hooks with prek install (prek, from the dev shell) or pre-commit install (pre-commit).

Continuous integration

.woodpecker/rust-and-flake-checks.yaml runs on Codeberg's Woodpecker CI for every push and pull request: the bootvine build with its tests, the xtask build, clippy, rustfmt, an evaluation of every flake output, and the commit-message check on pull requests. Builds on main are pushed to the wvhulle Cachix cache, which nixConfig in flake.nix offers as a substituter. The two VM checks need KVM, which Codeberg's runners lack, so they only run locally.

Releases

.woodpecker/release-pr-and-publish.yaml runs release-plz after the checks pass on main. It keeps a pull request labelled release open on Codeberg that bumps the version in Cargo.toml and adds the new commits to CHANGELOG.md. Only feat, fix and perf commits open one; a ! or a BREAKING CHANGE footer bumps the minor version while bootvine is below 1.0. Merging that pull request publishes the crate to crates.io, tags the merge v<version> and creates a Codeberg release with the changelog. Settings are in release-plz.toml.

The pipeline needs two Woodpecker secrets: codeberg_token, a Codeberg access token with repository write access, and cargo_registry_token, a crates.io token that may publish new crates and updates. Preview the next release locally from the dev shell with release-plz update.

Testing

What Command
Model and render tests cargo test --workspace
Scripted demos cargo run --bin scripted-boot (also scripted-shutdown, scripted-luks-unlock)
Sample machines in a window nix run .#sample-vm-<machine>, see the guide
Boot and shutdown in a VM nix build .#checks.x86_64-linux.vm-boot-and-shutdown
Passphrase prompt in a VM nix build .#checks.x86_64-linux.vm-luks-passphrase
Failure panel in a VM nix build .#checks.x86_64-linux.vm-failures

To watch your own user manager start the sample units:

units=$(nix build --no-link --print-out-paths .#sample-unit-files)
systemctl --user link --runtime $units/*
systemctl --user start --no-block bootvine-sample-services.target
cargo run --bin bootvine -- --user --target bootvine-sample-services.target --hold 3s
systemctl --user stop $(ls $units)
systemctl --user disable --runtime $(ls $units)

Everything a sample machine needs sits in its own folder under vm-tests/: machine.nix, and for the machines with a check, check.nix and check.py. vm-tests/shared/ holds the settings every machine shares, the window setup for nix run and the console helpers for the checks. A new machine is a new folder plus its name in vm-tests/default.nix.

The VM checks read the console as text, hold the boot at fixed points and wait on marker files instead of sleeping. The failures check starts each failing unit by hand, so it knows which one is newest in the panel. To step through one by hand, run nix run .#checks.x86_64-linux.vm-boot-and-shutdown.driverInteractive and call test_script().

Prefix VM and recording commands with env -u LD_LIBRARY_PATH when your shell exports libraries that clash with QEMU or Chromium.

Repository tasks

  • nix run .#record-screencasts re-records the animations from the scripted demos and copies the passphrase and failures screenshots from the VM checks into recordings/, for the README and the guide.
  • cargo xtask sync-default-config rewrites the defaults block in configuration from bootvine defaults.
  • cargo run --bin bootvine -- install --destdir <dir> --initrd dracut stages an install without touching the system; cargo run --bin bootvine -- uninstall --destdir <dir> removes it again.

Code style and design

  • Code style.
  • Architecture: the event loop, the console takeover and the workarounds for systemd's private socket.