;doc:RELEASING

This commit is contained in:
Simon Michael 2025-09-26 15:52:23 -10:00
parent dac0d5a4ee
commit 9406f7e22f

View File

@ -32,7 +32,7 @@ hledger major releases happen each quarter, normally at the start of the third m
Bugfix releases follow those when needed, usually soon after. Bugfix releases follow those when needed, usually soon after.
Preview/nightly releases may happen any time. Preview/nightly releases may happen any time.
| | Major&nbsp;release<br>A.B | Bugfix&nbsp;release<br>A.B.C | Preview/Nightly&nbsp;release<br>A.B.99 | | | Major&nbsp;release<br>A.B | Bugfix&nbsp;release<br>A.B.C | Preview/Nightly&nbsp;release<br>A.B.99 |
|---------------------|----------------------------------------------------------|------------------------------|------------------------------------------| |---------------------|----------------------------------------------------------|------------------------------|------------------------------------------|
| **Contains:** | New features, breaking changes | Only bug fixes | Early snapshot of the next major release | | **Contains:** | New features, breaking changes | Only bug fixes | Early snapshot of the next major release |
| **When:** | Start of third month in quarter: Mar, Jun, Sep, Dec | When needed | Occasionally, as needed | | **When:** | Start of third month in quarter: Mar, Jun, Sep, Dec | When needed | Occasionally, as needed |
@ -43,7 +43,7 @@ Preview/nightly releases may happen any time.
| Binaries | ✓ | ✓ | ✓ | | Binaries | ✓ | ✓ | ✓ |
| Hackage release | ✓ | ✓ | | | Hackage release | ✓ | ✓ | |
| Install page | ✓ | ✓ | | | Install page | ✓ | ✓ | |
| Regression&nbsp;bounties | ✓ | ✓ | | | Regression&nbsp;bounties | ✓ | ✓ | |
| Release notes | ✓ | ✓ | | | Release notes | ✓ | ✓ | |
| Manuals snapshot | ✓ | | | | Manuals snapshot | ✓ | | |
| Announcements | ✓ | | | | Announcements | ✓ | | |
@ -55,7 +55,6 @@ Preview/nightly releases may happen any time.
Higher things depend on lower things. Higher things depend on lower things.
Release readiness and the release process go from the bottom of this diagram to the top. Release readiness and the release process go from the bottom of this diagram to the top.
[![release diagram](RELEASING.png)](RELEASING.png) [![release diagram](RELEASING.png)](RELEASING.png)
<!-- source: RELEASING.canvas (Obsidian) --> <!-- source: RELEASING.canvas (Obsidian) -->
@ -135,7 +134,6 @@ It should be improved each time it is used.
changelogs, changelogs,
relnotes, relnotes,
announcements announcements
- nightly release changes link up to date in master (doc/ghnightlynotes.md)
- all packages uploaded correctly to hackage - all packages uploaded correctly to hackage
`just hackageupload` `just hackageupload`
- master branch pushed to github - master branch pushed to github
@ -154,15 +152,16 @@ It should be improved each time it is used.
`just reltags-push VER` `just reltags-push VER`
- github draft release with release binaries attached - github draft release with release binaries attached
<https://github.com/simonmichael/hledger/releases/new> *(XXX safari may not show new tag, may need brave)* <https://github.com/simonmichael/hledger/releases/new> *(XXX safari may not show new tag, may need brave)*
`just ghrel-notes` `just ghrel-notes` (in release branch)
`just ghbin-download` <!-- (or if throttled: `just ghbin`, download to tmp/, unzip the unix ones) --> `just ghruns-download` <!-- (or if throttled: `just ghbin`, download to tmp/, unzip the unix ones) -->
`just ghrel-bin VER` `just ghrel-upload VER`
- github release published - github release published
review, review,
publish publish
- github nightly release updated - github nightly release updated
`just nightly-tag-release` in master, update changes link in doc/ghnightlynotes.md
`just nightly-notes` `just ghnightly-notes`
`just nightly-tag`
- install instructions tested and working - install instructions tested and working
- stack - stack
- cabal - cabal