banger/docs
Thales Maciel 759fa20602
docs: add release-process runbook
Captures the cut-and-publish workflow currently encoded only in
scripts/publish-banger-release.sh and the CHANGELOG patterns. Covers:

- Release artefacts + R2 paths + the install.sh-at-bucket-root
  contract.
- Trust model recap (cosign pubkey pinned in both verify_signature.go
  and scripts/install.sh; drift check enforced by the publish script).
- Pre-flight checklist: green smoke, CHANGELOG entry with the right
  Keep-a-Changelog headings, link-table bump, explicit callout when
  unit files changed (banger update swaps binaries, not units).
- Cut order: publish first, tag after, verify from a clean machine.
- Verification-release rule: any fix to runUpdate / unit templates /
  helper-daemon restart sequencing requires an immediate no-op +1
  release so a host on the buggy version can update to it and observe
  the fix live with the new binary in the driver seat. v0.1.3 and
  v0.1.5 are the existing examples.
- Patch vs minor: minor = exposed API/contract change (vsock guest-
  agent protocol, CLI flag removal, RPC shape, non-forward-compatible
  store schema); everything else is patch.
- Sibling catalogs: kernel + golden-image entries are go:embed-ed,
  so they piggyback on the next banger release.
- Mid-release recovery for signature drift, partial rclone, re-cut,
  and bad-tag cleanup (never reuse a version).

AGENTS.md gets a one-liner pointer so the maintainer guide surfaces
the runbook without duplicating it.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-01 12:25:36 -03:00
..
reference Reorganize the source checkout layout 2026-03-21 17:22:57 -03:00
advanced.md daemon: split owner daemon from root helper 2026-04-26 12:43:17 -03:00
config.md docs: add config.md reference for the daemon TOML schema 2026-04-28 15:11:18 -03:00
dns-routing.md daemon: split owner daemon from root helper 2026-04-26 12:43:17 -03:00
image-catalog.md docs: promote vm run + image catalog as the happy path 2026-04-18 15:33:30 -03:00
kernel-catalog.md docs: resync package docs, AGENTS, and kernel-catalog with current code 2026-04-22 13:01:11 -03:00
oci-import-internals.md docs: fix paths from local to system install 2026-04-30 10:49:10 -03:00
oci-import.md docs: fix paths from local to system install 2026-04-30 10:49:10 -03:00
privileges.md update: docs + publish script for the self-update feature 2026-04-29 12:43:46 -03:00
release-process.md docs: add release-process runbook 2026-05-01 12:25:36 -03:00