theupriser/steamify-cachyos
1
0 Fork 0
mirror of https://github.com/theupriser/steamify-cachyos.git synced 2026-10-03 17:41:58 +02:00
Code Issues Actions Packages Projects Releases 8 Wiki Activity

docs: Versioning and release rules in AGENTS.md

Browse Source
This commit is contained in:
theupriser committed 2026-09-24 10:08:22 +02:00
1 parent 04891ee2cd
commit b2858d3d60
2 files changed
+16 -4
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

AGENTS.md
+14 -3
View File
@@ -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), - Comments explain *why* (the CachyOS/Plasma quirk being worked around),
not what the next line does. not what the next line does.
- **Versioning.** SemVer in `VERSION` (`setup-gamescope-boot.sh`, shown in - **Versioning and releases.** SemVer in `VERSION` (`setup-gamescope-boot.sh`,
the menu header and the bundle). Every commit gets an entry in shown in the menu header and the bundle header).
`CHANGELOG.md` under its version; a new PR/branch bumps the version. - 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 `## <VERSION> - <date>`: 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 ## Non-obvious behaviour to preserve
CHANGELOG.md
+2 -1
View File
@@ -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. `lib/state.sh`), which would have failed the CI check.
- `d7231eb` **chore: Move the bundle tool to .github/tools/bundle.sh** - `d7231eb` **chore: Move the bundle tool to .github/tools/bundle.sh**
- `5c00504` **docs: Commit hashes in the changelog** - `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 - Each push to `main` publishes release `v$VERSION` with that version's
changelog; an already released version is never overwritten (pull requests changelog; an already released version is never overwritten (pull requests
get a warning when `VERSION` wasn't bumped). get a warning when `VERSION` wasn't bumped).
- Install with `.../releases/latest/download/setup-gamescope-boot.sh`, which - Install with `.../releases/latest/download/setup-gamescope-boot.sh`, which
always points to the newest release. always points to the newest release.
- **docs: Versioning and release rules in AGENTS.md**
## 0.6.2 - 2026-09-23 ## 0.6.2 - 2026-09-23