enricobuehlerandClaude Opus 4.8
15d09a8c10
ci / web (push) Successful in 51s
ci / docs-site (push) Successful in 1m5s
apple / swift (push) Successful in 1m25s
decky / build-publish (push) Successful in 21s
docker / build-push (--build-arg FEDORA_VERSION=44, ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora44-rpm) (push) Successful in 9s
docker / build-push (., web/Dockerfile, punktfunk-web) (push) Successful in 10s
docker / build-push (ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora-rpm) (push) Successful in 9s
docker / build-push (ci, ci/rust-ci-noble.Dockerfile, punktfunk-rust-ci-noble) (push) Successful in 9s
docker / build-push (ci, ci/rust-ci.Dockerfile, punktfunk-rust-ci) (push) Successful in 10s
docker / build-push (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Successful in 10s
ci / bench (push) Successful in 6m55s
apple / screenshots (push) Successful in 6m47s
deb / build-publish (push) Successful in 11m23s
android / android (push) Successful in 12m36s
arch / build-publish (push) Successful in 12m46s
docker / deploy-docs (push) Successful in 23s
deb / build-publish-host (push) Successful in 12m32s
rpm / build-publish (43, bazzite, punktfunk-fedora-rpm) (push) Successful in 16m9s
ci / rust (push) Successful in 26m29s
rpm / build-publish (44, fedora-44, punktfunk-fedora44-rpm) (push) Successful in 20m30s
Release notes now live in the repo at docs/releases/vX.Y.Z.md, authored during the version bump (before the tag). ensure_release (gitea-release.sh + .ps1 twin) seeds the Gitea release body from that file in the create POST, so the release is born WITH its notes instead of being created empty and PATCHed afterward. canary/rc have no file -> empty body, unchanged. New manual `announce` workflow (workflow_dispatch, tag input) re-syncs the notes file over the live release and posts a violet embed (title, notes lead-in, release-page link) to the Discord #releases channel via the DISCORD_RELEASE_WEBHOOK secret. Stable-only: a -rc tag is refused unless allow_prerelease=true. Pressing "go" is the quality gate, so a half-built or failed release is never announced. docs/releases/README.md documents the ritual; TEMPLATE.md is the skeleton. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
46 lines
2.5 KiB
Markdown
46 lines
2.5 KiB
Markdown
# Release notes
|
|
|
|
One file per **stable** release: `docs/releases/vX.Y.Z.md`. Its contents become the Gitea release
|
|
body **verbatim** and are the source of the Discord `#releases` announcement.
|
|
|
|
## Why this exists
|
|
|
|
Releases used to be created by CI with an **empty body**; the notes were pasted in by hand
|
|
afterward. That left a window where the release — and anything announcing it — carried no notes.
|
|
Now the notes are authored **before the tag is pushed**, as part of the version bump, so the
|
|
release is born complete and the announcement always has something to say.
|
|
|
|
## The flow
|
|
|
|
1. **Write the notes.** Add `docs/releases/vX.Y.Z.md` in the same commit (or PR) as the version
|
|
bump. Copy `TEMPLATE.md` and fill it in. This file is the single source of truth for the body.
|
|
2. **Tag & push.** `git tag -a vX.Y.Z … && git push origin vX.Y.Z` fans out to the build
|
|
workflows. Whichever one wins the create race seeds the release body from this file
|
|
(`scripts/ci/gitea-release.sh` → `ensure_release`, and its PowerShell twin). The release page
|
|
shows the notes immediately.
|
|
3. **Wait for green.** Let every platform's CI finish and go green.
|
|
4. **Announce.** Dispatch the `announce` workflow (`.gitea/workflows/announce.yml`) with the tag.
|
|
It re-asserts this file over the live release (so any late edit wins) and posts an embed to
|
|
Discord `#releases`. Pressing "go" is the quality gate — a half-built release is never
|
|
announced. Stable-only; a `-rc` tag is refused unless `allow_prerelease=true`.
|
|
|
|
Editing the notes after the tag is fine: update this file, then re-run step 4 (or PATCH the body
|
|
via the API) — the announce step always re-syncs from the file, so the file stays authoritative
|
|
even across a tag re-point.
|
|
|
|
Canary / `-rc` builds have **no** file here on purpose: they get no curated body and are not
|
|
announced.
|
|
|
|
## Format
|
|
|
|
Match the house style (see any recent `vX.Y.Z.md`):
|
|
|
|
- Open with a **wire-compatibility** line — *"Wire-compatible with X.Y.x — existing pairings and
|
|
clients keep working."* — plus a one-sentence fallback/negotiation note. This lead-in (all text
|
|
before the first `##` header) is what the Discord embed shows, so make it a real summary.
|
|
- Then `## Section` headers grouping the changes, with **bold lead-in** bullets.
|
|
- Be concrete: env vars, ABI/protocol versions, on-glass-verified hardware, platform scope.
|
|
|
|
The short annotated-**tag** message stays separate and short (a headline + a paragraph); it is the
|
|
tag object's message, not this file.
|