From 1604ed10d467df0be93cc542ac267e5b8ffaa336 Mon Sep 17 00:00:00 2001 From: Rick Peters Date: Thu, 24 Sep 2026 10:08:22 +0200 Subject: [PATCH] docs: Versioning and release rules in AGENTS.md --- AGENTS.md | 17 ++++++++++++++--- CHANGELOG.md | 3 ++- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 72ef0bd..5719eb1 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -59,9 +59,20 @@ gamescope and the Plasma desktop. Primary target: the Valve Steam Machine - Comments explain *why* (the CachyOS/Plasma quirk being worked around), not what the next line does. -- **Versioning.** SemVer in `VERSION` (`setup-gamescope-boot.sh`, shown in - the menu header and the bundle). Every commit gets an entry in - `CHANGELOG.md` under its version; a new PR/branch bumps the version. +- **Versioning and releases.** SemVer in `VERSION` (`setup-gamescope-boot.sh`, + shown in the menu header and the bundle header). + - Every commit gets an entry in `CHANGELOG.md` under its version (short hash + + subject; a commit can't contain its own hash, so fill it in with the + next commit). The section heading must be `## - `: CI + cuts the release notes out of the changelog by that heading. + - Every PR that should be released bumps `VERSION` and adds its section. + A push to `main` publishes release `v$VERSION` (tag + bundle + that + changelog section) and marks it latest. An existing version is never + overwritten: without a bump nothing is released, and pull requests show + a warning. + - Users install through `releases/latest/download/setup-gamescope-boot.sh`, + which always resolves to the newest release. The old rolling `latest` tag + and release are from before 0.7.0 and are no longer updated. ## Non-obvious behaviour to preserve diff --git a/CHANGELOG.md b/CHANGELOG.md index a05ee36..4805eee 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -45,12 +45,13 @@ Machine LED driver works on every installed kernel and survives kernel updates. `lib/state.sh`), which would have failed the CI check. - `d7231eb` **chore: Move the bundle tool to .github/tools/bundle.sh** - `5c00504` **docs: Commit hashes in the changelog** -- **ci: A release per version (tag v0.7.0, ...) instead of overwriting "latest"** +- `8aab946` **ci: A release per version (tag v0.7.0, ...) instead of overwriting "latest"** - Each push to `main` publishes release `v$VERSION` with that version's changelog; an already released version is never overwritten (pull requests get a warning when `VERSION` wasn't bumped). - Install with `.../releases/latest/download/setup-gamescope-boot.sh`, which always points to the newest release. +- **docs: Versioning and release rules in AGENTS.md** ## 0.6.2 - 2026-09-23