mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-03-20 12:11:28 -07:00
35 lines
1.7 KiB
Markdown
35 lines
1.7 KiB
Markdown
<!-- read_when: cutting a tagged release or debugging release prep -->
|
|
|
|
# Releasing
|
|
|
|
1. Confirm `main` is green: `gh run list --workflow CI --limit 5`.
|
|
2. Confirm release-facing docs are current: `README.md`, `changes/*.md`, and any touched `docs-site/` pages/config examples.
|
|
3. Run `bun run changelog:lint`.
|
|
4. Bump `package.json` to the release version.
|
|
5. Build release metadata before tagging:
|
|
`bun run changelog:build --version <version> --date <yyyy-mm-dd>`
|
|
6. Review `CHANGELOG.md` and `release/release-notes.md`.
|
|
7. Run release gate locally:
|
|
`bun run changelog:check --version <version>`
|
|
`bun run verify:config-example`
|
|
`bun run typecheck`
|
|
`bun run test:fast`
|
|
`bun run test:env`
|
|
`bun run build`
|
|
8. If `docs-site/` changed, also run:
|
|
`bun run docs:test`
|
|
`bun run docs:build`
|
|
9. Commit release prep.
|
|
10. Tag the commit: `git tag v<version>`.
|
|
11. Push commit + tag.
|
|
|
|
Notes:
|
|
|
|
- Versioning policy: SubMiner stays 0-ver. Large or breaking release lines still bump the minor number (`0.x.0`), not `1.0.0`. Example: the next major line after `0.6.5` is `0.7.0`.
|
|
- 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.
|
|
- Do not tag while `changes/*.md` fragments still exist.
|
|
- 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.
|