docs: how to cut a release

2026-09-04 01:53:23 +00:00
parent fe4f2a8f55
commit acc5fdc2f3
1 changed files with 11 additions and 0 deletions
@@ -79,6 +79,17 @@ Architecture and the reasoning behind it: [docs/ARCHITECTURE.md](docs/ARCHITECTU
 Versions and what changed in each: [CHANGELOG.md](CHANGELOG.md). The running
 version is in the page footer and at `GET /healthz`.

+To cut a release: move the `[Unreleased]` notes in `CHANGELOG.md` under a new
+`## [x.y.z] - date` heading, set the same version in `package.json`, commit, then tag
+and publish the Gitea release with the changelog section as its notes:
+
+```bash
+git tag -a vx.y.z -m "Courtside x.y.z" && git push origin --tags
+# Gitea → Releases → Draft a release on tag vx.y.z, or POST /api/v1/repos/bkvargyas/courtside/releases
+```
+
+A push to `main` deploys; the tag and release record which commit each version was.
+
 ## License

 MIT. See [LICENSE](LICENSE).