protokill RELEASING.md
2.4 kB · 57 lines
Markdown
at main

Releasing protokill #

A release is an annotated tag vX.Y.Z on main plus the web bundle built from the tagged tree. Amplify deploys main; the tag records what shipped.

Version Release
v0.1.0 The 7DRL jam build, 2026-03-09.
v0.2.0 The next release, from main around 2026-11-21.
v0.3.0 The vertical slice (M1).

Cut a release #

From a clean main that matches origin/main:

scripts/release.sh --dry-run 0.2.0   # run every check, print the plan
scripts/release.sh 0.2.0             # cut it, locally
scripts/release.sh --push 0.2.0      # ...or cut it and push after asking

The script refuses unless the tree is clean, HEAD is main at origin/main, the version is semver greater than the latest v* tag, and scripts/ci.sh --full passes: every native test, the doctests and the wasm tests. It then:

  1. sets the version once, in [workspace.package] in Cargo.toml (every workspace crate inherits it), and updates Cargo.lock;
  2. moves the Unreleased changelog entries under the new version heading and records the shipped RULESET_VERSION;
  3. commits release: vX.Y.Z and creates the annotated tag;
  4. builds the production bundle with scripts/deploy.sh --production and reports its path, output/.

--push prints the two refspecs it will push and asks before pushing.

Tag a release that already shipped #

--tag-only annotates an existing commit and changes nothing else:

scripts/release.sh --tag-only v0.1.0 b8c16d48

v0.1.0 is tagged this way: the 7DRL build's tree is left exactly as it was.

Release version and ruleset version #

They are independent. vX.Y.Z is the release's name and moves whenever a bundle is cut. RULESET_VERSION (crates/game/mission/src/lib.rs) names the encoding of mission state, plans, actions and digests; it moves only when something stored or hashed changes. A release records the ruleset it shipped, so state or an audit can be tied to both.

The version in the game #

The build reads git describe --tags at build time. A production build shows it in the status bar (v0.2.0, or v0.1.0-812-gabc1234 between releases); a preview build also shows the build time. With no tags (shallow clones, tarballs) it falls back to the short commit SHA, then to unknown. build-info.json in the bundle carries the same values.