slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc: RELEASING

Browse Source
This commit is contained in:
Simon Michael 2025-05-16 14:20:43 -10:00
parent bd449dfc55
commit 2d28604c74
1 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/RELEASING.md
View File

@ -78,7 +78,9 @@ It should be improved each time it is used.
- [ ] cabal files x 4 (hledger*/hledger*.cabal) - [ ] cabal files x 4 (hledger*/hledger*.cabal)
`just relbranch VER`, `just relbranch VER`,
`just cabalfilestest` `just cabalfilestest`
- [ ] options help texts up to date (in CliOptions.hs, UIOptions.hs, WebOptions.hs) - [ ] options help texts up to date (in CliOptions.hs, UIOptions.hs, WebOptions.hs)
`stack build`
`./Shake cmddocs -c`
- [ ] embedded manuals x 3 - [ ] embedded manuals x 3
- [ ] generaloptions macro (in doc/common.m4) - [ ] generaloptions macro (in doc/common.m4)
- [ ] tool specific options in manuals (hledger*/hledger*.m4.md > # Options) - [ ] tool specific options in manuals (hledger*/hledger*.m4.md > # Options)
@ -86,6 +88,7 @@ It should be improved each time it is used.
- [ ] man (hledger*/hledger*.1) - [ ] man (hledger*/hledger*.1)
- [ ] info (hledger*/hledger*.info) - [ ] info (hledger*/hledger*.info)
- [ ] text (hledger*/hledger*.txt) - [ ] text (hledger*/hledger*.txt)
`./Shake mandates`
`./Shake manuals -c` `./Shake manuals -c`
- [ ] embedded tldr pages synced with upstream (doc/tldr/*) - [ ] embedded tldr pages synced with upstream (doc/tldr/*)
`just tldr-diff` `just tldr-diff`
@ -98,9 +101,9 @@ It should be improved each time it is used.
- [ ] release docs and artifacts - [ ] release docs and artifacts
- [ ] draft binaries building started - [ ] draft binaries building started
`just relbin` `just relbin`
- [ ] hledger.org html manuals x 3 (site/src/VER/*.md) - [ ] hledger.org html manuals x 3 (`site/src/MAJORVER/*.md`)
`just site-manuals-snapshot VER` `just site-manuals-snapshot MAJORVER` (creates or updates)
update `site/Makefile`, `site/js/site.js`, `site/hledger.org.caddy` update `site/Makefile`, `site/js/site.js`, `site/hledger.org.caddy` (major release only)
- [ ] release notes @ hledger.org (doc/relnotes.md) - [ ] release notes @ hledger.org (doc/relnotes.md)
`just relnotes`, `just relnotes`,
select & transform with `md-issue-refs`, select & transform with `md-issue-refs`,
@ -135,16 +138,16 @@ It should be improved each time it is used.
`hledgerorgsh grep release.= /opt/hledger/site/out/js/site.js` `hledgerorgsh grep release.= /opt/hledger/site/out/js/site.js`
- [ ] https://www.hledger.org/js/site.js showing latest version - [ ] https://www.hledger.org/js/site.js showing latest version
`curl -s https://hledger.org/js/site.js | grep release.=` `curl -s https://hledger.org/js/site.js | grep release.=`
purge cache at https://dash.cloudflare.com/f629035917dd3b99b1e37ae20c15ff09/hledger.org/caching/configuration purge cache at https://dash.cloudflare.com/f629035917dd3b99b1e37ae20c15ff09/hledger.org/caching/configuration (major release only)
- [ ] default manual urls redirecting to latest version - [ ] default manual urls redirecting to latest version (major release only)
`hledgerorgsh sh -c 'systemctl stop caddy; systemctl start caddy'` `hledgerorgsh sh -c 'systemctl stop caddy; systemctl start caddy'`
`curl -sI https://hledger.org/hledger.html | grep location` `curl -sI https://hledger.org/hledger.html | grep location`
- [ ] release branch pushed to github - [ ] release branch pushed to github
- [ ] release tags pushed to github - [ ] release tags pushed to github
`just reltags-push VER` `just reltags-push VER`
- [ ] github draft release with release binaries attached - [ ] github draft release with release binaries attached
(should be autocreated by the above; if not, https://github.com/simonmichael/hledger/releases/new) (should be autocreated by the above; if not, https://github.com/simonmichael/hledger/releases/new; and/or by..
`just ghrelnotes-push` `just ghrel-notes`
`just ghruns-download` (or if throttled: `just ghruns-open`, download to tmp/, unzip the unix ones) `just ghruns-download` (or if throttled: `just ghruns-open`, download to tmp/, unzip the unix ones)
`just ghrel-upload VER` `just ghrel-upload VER`
- [ ] github release published - [ ] github release published
@ -166,7 +169,7 @@ It should be improved each time it is used.
- [ ] review/polish relnotes, changelogs - [ ] review/polish relnotes, changelogs
review, edit review, edit
propagate propagate
- [ ] new dev tag/versions/man dates in master - [ ] new dev tag/versions/man dates in master (major version only)
`j devtag VER.99` `j devtag VER.99`
- [ ] pta.o project stats updated - [ ] pta.o project stats updated
- [ ] process notes updated/cleaned - [ ] process notes updated/cleaned