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

;doc:RELEASING: drop checkboxes

Browse Source
This commit is contained in:
Simon Michael 2025-09-16 10:29:21 -07:00
parent 75325fe626
commit 980a0d6e45
1 changed files with 64 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

128
doc/RELEASING.md
View File

@ -67,120 +67,120 @@ It should be improved each time it is used.
<!-- Trailing double spaces are used for line breaks --> <!-- Trailing double spaces are used for line breaks -->
- [ ] **1. product** - **1. product**
- [ ] blocking defects resolved - blocking defects resolved
- [ ] desired improvements landed and stabilised - desired improvements landed and stabilised
- [ ] building and passing tests with current ghcs, deps, and stackage snapshots - building and passing tests with current ghcs, deps, and stackage snapshots
- [ ] building and passing tests on all platforms / with all ghc versions - building and passing tests on all platforms / with all ghc versions
`just relbin` (or push to github `binaries[-*]` branch) `just relbin` (or push to github `binaries[-*]` branch)
`just oldest` (or push to github `oldest` branch) `just oldest` (or push to github `oldest` branch)
- [ ] **2. product docs and metadata** - **2. product docs and metadata**
- [ ] release branch - release branch
- [ ] version strings (in **/.version, */.version.m4, */package.yaml) - version strings (in **/.version, */.version.m4, */package.yaml)
- [ ] 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` `stack build`
`./Shake cmddocs -c` `./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)
- [ ] man page dates (*/.date.m4) - man page dates (*/.date.m4)
- [ ] 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 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`
- [ ] embedded asciinema demos (hledger/embeddedfiles/*.cast) - embedded asciinema demos (hledger/embeddedfiles/*.cast)
- [ ] shell completions (hledger/shell-completion/hledger-completion.bash) - shell completions (hledger/shell-completion/hledger-completion.bash)
`just completions`, commit any changes `just completions`, commit any changes
- [ ] changelogs x 5 (**/CHANGES.md) - changelogs x 5 (**/CHANGES.md)
`just changelogs [-c]` `just changelogs [-c]`
add issue links with `md-issue-refs`, uniquify add issue links with `md-issue-refs`, uniquify
add notable changes from site, finance repos to project changelog (major release only) add notable changes from site, finance repos to project changelog (major release only)
`just changelogs-finalise` `just changelogs-finalise`
- [ ] **3. release docs and artifacts** - **3. release docs and artifacts**
- [ ] draft binaries building started - draft binaries building started
`just relbin` `just relbin`
- [ ] hledger.org html manuals x 3 (`site/src/MAJORVER/*.md`) - hledger.org html manuals x 3 (`site/src/MAJORVER/*.md`)
`just site-manuals-snapshot MAJORVER` (creates or updates) `just site-manuals-snapshot MAJORVER` (creates or updates)
update `site/Makefile`, `site/js/site.js`, `site/hledger.org.caddy` (major release only) 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` *(XXX minor release: moves previous release's summary, adds whitespace)*, `just relnotes` *(XXX minor release: moves previous release's summary, adds whitespace)*,
*(XXX may be no longer needed)* select & transform with `md-issue-refs`, uniquify *(XXX may be no longer needed)* select & transform with `md-issue-refs`, uniquify
add author github nicks, add author github nicks,
add summary, add summary,
commit commit
- [ ] github binary install docs (doc/ghrelnotes.md) up to date and pre-tested - github binary install docs (doc/ghrelnotes.md) up to date and pre-tested
- [ ] Install page (site/src/install.md) up to date and pre-tested - Install page (site/src/install.md) up to date and pre-tested
- [ ] draft announcement for chat / mail list (doc/ANNOUNCE) - draft announcement for chat / mail list (doc/ANNOUNCE)
- [ ] draft announcement for mastodon (doc/ANNOUNCE.masto) - draft announcement for mastodon (doc/ANNOUNCE.masto)
- [ ] release tags - release tags
`just reltags` `just reltags`
- [ ] release binaries built from tag - release binaries built from tag
`just relbin` `just relbin`
wait for all to succeed wait for all to succeed
- [ ] Install page (site/src/install.md) --version examples match release binaries - Install page (site/src/install.md) --version examples match release binaries
- [ ] **4. published** - **4. published**
- [ ] relevant release branch work cherry-picked to master branch - relevant release branch work cherry-picked to master branch
changelogs, changelogs,
relnotes, relnotes,
announcements announcements
- [ ] nightly release changes link up to date in master (doc/ghnightlynotes.md) - 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`, check versions, confirm, check all uploads successful `just hackageupload`, check versions, confirm, check all uploads successful
- [ ] master branch pushed to github - master branch pushed to github
- [ ] new manuals published and rendering/redirecting correctly - new manuals published and rendering/redirecting correctly
- [ ] site repo pushed to github - site repo pushed to github
- [ ] main and site repos auto-pulled to hledger.org, site rebuilt - main and site repos auto-pulled to hledger.org, site rebuilt
`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 (major release only) purge cache at https://dash.cloudflare.com/f629035917dd3b99b1e37ae20c15ff09/hledger.org/caching/configuration (major release only)
- [ ] default manual urls redirecting to latest version (major release only) - 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
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`
`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
review, review,
publish publish
- [ ] github nightly release updated - github nightly release updated
`just nightly-tag-release` `just nightly-tag-release`
`just nightly-notes` `just nightly-notes`
- [ ] install instructions tested and working - install instructions tested and working
- [ ] stack - stack
- [ ] cabal - cabal
- [ ] source checkout - source checkout
- [ ] github release > How to install, each platform - github release > How to install, each platform
- [ ] announced - announced
- [ ] mail list(s) hledger@googlegroups.com for major (+ haskell-cafe@googlegroups.com for supermajor) - mail list(s) hledger@googlegroups.com for major (+ haskell-cafe@googlegroups.com for supermajor)
- [ ] matrix - matrix
- [ ] irc - irc
- [ ] mastodon - mastodon
- [ ] pta forum - pta forum
- [ ] **5. cleanup and support** - **5. cleanup and support**
- [ ] review/polish relnotes, changelogs - review/polish relnotes, changelogs
review, edit review, edit
propagate propagate
- [ ] new dev tag/versions/man dates in master (major version only) - new dev tag/versions/man dates in master (major version only)
`j devtagø` `j devtagø`
- [ ] pta.o project stats updated - pta.o project stats updated
- [ ] process notes updated/cleaned - process notes updated/cleaned
- [ ] monitor/support/handle issues: - monitor/support/handle issues:
[issue tracker](https://github.com/simonmichael/hledger/issues?q=is%3Aopen+is%3Aissue), matrix, irc, mail list, forum, reddit [issue tracker](https://github.com/simonmichael/hledger/issues?q=is%3Aopen+is%3Aissue), matrix, irc, mail list, forum, reddit
After release, it's a good time for: After release, it's a good time for: