From eddf6f04567701a93f0cac5c3571e60af505ac52 Mon Sep 17 00:00:00 2001 From: sudacode Date: Fri, 20 Mar 2026 03:15:05 -0700 Subject: [PATCH] docs: document release changelog recovery path --- docs/RELEASING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/RELEASING.md b/docs/RELEASING.md index d99af2f..80a059d 100644 --- a/docs/RELEASING.md +++ b/docs/RELEASING.md @@ -8,6 +8,7 @@ 4. Bump `package.json` to the release version. 5. Build release metadata before tagging: `bun run changelog:build --version --date ` + - Release CI now also auto-runs this step when releasing directly from a tag and `changes/*.md` fragments remain. 6. Review `CHANGELOG.md` and `release/release-notes.md`. 7. Run release gate locally: `bun run changelog:check --version ` @@ -29,6 +30,8 @@ Notes: - Pass `--date` explicitly when you want the release stamped with the local cut date; otherwise the generator uses the current ISO date, which can roll over to the next UTC day late at night. - `changelog:check` now rejects tag/package version mismatches. - `changelog:build` generates `CHANGELOG.md` + `release/release-notes.md` and removes the released `changes/*.md` fragments. +- In the same way, the release workflow now auto-runs `changelog:build` when it detects unreleased `changes/*.md` on a tag-based run, then verifies and publishes. - Do not tag while `changes/*.md` fragments still exist. +- If you need to repair a published release body (for example, a prior version’s section was omitted), regenerate notes from `CHANGELOG.md` and re-edit the release with `gh release edit --notes-file`. - Tagged release workflow now also attempts to update `subminer-bin` on the AUR after GitHub Release publication. - Required GitHub Actions secret: `AUR_SSH_PRIVATE_KEY`. Add the matching public key to your AUR account before relying on the automation.