--- name: release description: Cut and ship a Series of Tubes release (patch or minor) from main via the auto-release workflow. --- # Releasing Series of Tubes Bumping `version` in `package.json` on `main` is the release button. The `auto-release.yml` workflow tests, tags `v`, publishes a GitHub release with that version's CHANGELOG section as notes, and dispatches `release.yml`, which deploys to GitHub Pages (https://seriesoftub.es). ## Not everything needs a release Release only when there is something worth shipping to players: a feature, a fix they will notice, or a decent batch of smaller changes. Docs, skills, CI, issue templates, tests and refactors never need a release on their own; just push them. Small player-facing tweaks can sit under `## [Unreleased]` until a real release comes along. Don't plan a release just because the hour is up, and when unsure, ask the user. ## At most one release per hour Players get an update banner and a "What's new" window for every release, so ship at most one release an hour. Before bumping, check when the last one went out: ```bash gh api repos/fjaeckel/seriesoftubes/releases/latest --jq '.tag_name+" "+.published_at' ``` - **Less than 60 minutes ago:** don't bump. Commit and push the work with its bullets under `## [Unreleased]`; it goes out with the next release. Tell the user when the next release slot opens. - **60 minutes or more:** release everything under `## [Unreleased]` together, as one version. - **Only exception:** the live game is broken for players (it won't start, saves are lost, a phone can't get past a screen). Then hotfix right away as a patch release. ## Pick the version - Several changes batched together: use the biggest one (any feature → minor). - Patch (`x.y.Z`): fixes, small tweaks, wording, icons. - Minor (`x.Y.0`): new features or content. ## Steps 1. Make sure `main` is green: `npm test` and `node scripts/i18n-check.js` ("0 missing, 0 unused, 0 broken"). 2. In `CHANGELOG.md`, move the bullets from `## [Unreleased]` into a new section right below it: `## [x.y.z] — YYYY-MM-DD` (em dash, today's date). Keep an empty `## [Unreleased]` heading above it. The build fails if the section has no bullets. 3. Bump the version in **both** files: - `package.json` → `"version"` - `package-lock.json` → top-level `"version"` and `packages[""].version` 4. `npm test` once more. 5. Commit on `main` as Frederic, with no attribution trailers: ```bash git -c user.name="Frederic Jung" -c user.email="frederic@jc-ix.net" commit \ --author="Frederic Jung " -m "Short summary (x.y.z)" git push origin main ``` 6. Watch the workflows until both finish: ```bash gh run list --repo fjaeckel/seriesoftubes --limit 4 gh run watch --repo fjaeckel/seriesoftubes ``` 7. Confirm it is live: `https://seriesoftub.es/version.json` shows the new version. ## Release notes rules - The first sentence of each bullet is all the in-app "What's new" shows (at most five bullets; longer notes get a link to the full GitHub release). Make that sentence stand on its own: "Tier 1 networks can lay their own subsea cable (#22)." Detail goes after it. - Written for players, in plain English. One bullet per change, issue numbers like `(#37)`. - Never mention hidden easter eggs or explain jokes. - No internal function names. ## If something fails - "not newer than the latest release": the version was not bumped, or was bumped backwards. - "CHANGELOG.md has no notes under ## [x.y.z]": the heading doesn't match the version exactly or has no bullets. - Tests fail in the workflow but pass locally: look for unseeded randomness in a test. - Fix forward with a new patch version; never move or delete an existing tag.