;doc: RELEASING tweaks

This commit is contained in:
Simon Michael 2023-12-01 22:02:30 -10:00
parent 2b7e34a247
commit 565e068a00

View File

@ -171,6 +171,7 @@ See [CHANGELOGS](CHANGELOGS.md).
#### Release branch and version number #### Release branch and version number
Create release branch if needed, update all package versions, help, manuals, changelogs (preferred): Create release branch if needed, update all package versions, help, manuals, changelogs (preferred):
- `./bake prep NEW` - `./bake prep NEW`
- First ensure `hpack --version` matches the one in `stack --version`
- NEW is `MA.JOR[.MINOR|.99.PREVIEWNUM]` (eg 1.24.99.1 for 1.25 preview 1) - NEW is `MA.JOR[.MINOR|.99.PREVIEWNUM]` (eg 1.24.99.1 for 1.25 preview 1)
- for troubleshooting: bash -x PAUSE=1 ECHO=1 bake ... - for troubleshooting: bash -x PAUSE=1 ECHO=1 bake ...
<!-- - "avoid possible bug with being in master instead" (?) --> <!-- - "avoid possible bug with being in master instead" (?) -->
@ -261,6 +262,10 @@ Sanity checks:
- ensure no new commits have been made since push to `github/binaries` - ensure no new commits have been made since push to `github/binaries`
- in the release branch (?): `make tag` - in the release branch (?): `make tag`
#### Hackage packages
in main repo, release branch:
- `make hackageupload` (major/bugfix/fixup release)
#### Github release #### Github release
- in main repo, release branch: - in main repo, release branch:
- `git push github MA.JOR-branch` or magit `P p` - `git push github MA.JOR-branch` or magit `P p`
@ -269,7 +274,7 @@ Sanity checks:
- choose release tag - choose release tag
- title: VERSION - title: VERSION
- description: - description:
- copy doc/github-release-doc.tmpl.md to emacs - copy doc/github-release.md to emacs
- insert latest release notes (minus topmost heading) from site/src/release-notes.md - insert latest release notes (minus topmost heading) from site/src/release-notes.md
- replace all OLD version strings with NEW - replace all OLD version strings with NEW
- copy to github release - copy to github release
@ -278,10 +283,6 @@ Sanity checks:
- Save draft - Save draft
- (and after successful hackage upload: Publish release) - (and after successful hackage upload: Publish release)
#### Hackage packages
in main repo, release branch:
- `make hackageupload` (major/bugfix/fixup release)
#### Release manuals #### Release manuals
(major release) (major release)
@ -324,7 +325,7 @@ In site repo:
hledgerorg emacs, open /opt/hledger/site/hledger.org.caddy: hledgerorg emacs, open /opt/hledger/site/hledger.org.caddy:
- @oldmanpath: add `path` for NEW - @oldmanpath: add `path` for NEW
- @unversionedmanpath: update to NEW - @unversionedmanpath: update to NEW
- `systemctl reload caddy` - `make caddy-restart`
- check site in browser - check site in browser
- install page versions, badge colours - install page versions, badge colours
- manuals' versions list in browser. If not updating, try - manuals' versions list in browser. If not updating, try