doc: RELEASING, CHANGELOGS

This commit is contained in:
Simon Michael 2022-09-18 10:03:44 -10:00
parent a3c2e2c1ba
commit f0b16f22a2
2 changed files with 10 additions and 7 deletions

View File

@ -13,8 +13,8 @@ Before release, and preferably daily/weekly as well:
- open changelogs
- as VSC panes:
- explorer
- unfold hledger, hledger-lib, hledger-ui, hledger-web directories
- filter list to CHANGES
- unfold hledger, hledger-lib, hledger-ui, hledger-web directories (?)
- CMD-f, changesmd, click filter icon
- click project CHANGES (last one in list)
- click editor pane, split it, click rightmost editor pane
- click hledger CHANGES
@ -53,8 +53,7 @@ Before release, after cherry-picking changes from master to the release branch:
## Old notes
Changelogs are plain text, but started including some markdown formatting
from 1.0. Should make consistent.
Changelogs started using markdown from 1.0 onward. Should make consistent.
Changelogs started mentioning committer names from 2017/1,
for hledger-ui-1.1.1 (because they won't appear on the release notes).

View File

@ -119,7 +119,8 @@ These have complex interdependencies and sequencing constraints. Chunk, separate
- [make new manuals](#make-new-manuals) (major release)
- [update hledger-install](#update-hledger-install) (major/bugfix/fixup release)
- [update install page](#update-install-page) (major/bugfix/fixup release)
- [make announcement](#make-announcement) (major/bugfix release)
- [make announcement](#make-announcement) (major/notable bugfix release)
- on release branch do `./Shake setversion NEW -c`
- [tag the release](#tag-the-release)
- [make release binaries](#make-release-binaries)
- [make github release](#make-github-release) draft
@ -151,7 +152,7 @@ In site repo:
- copy template, uncomment
- replace date
- replace XX with NEW
- add new changelog sections, excluding hledger-lib
- add new content from changelogs, excluding hledger-lib
- remove any empty sections
- add contributors, `git shortlog -sn OLD..NEW`
- add summary (major release) or remove it (bugfix release)
@ -222,12 +223,15 @@ In release branch:
- commit: `;doc: announce`
#### Tag the release
- ensure new version has been set with Shake setversion !
- `make tag`
#### Make release binaries
- wait for any pending successful builds to complete and update cache
- `tools/release bin`
- get all platforms built on the same commit
- download binary artifact zip files
- delete any local downloaded binaries from last release
- download binary artifact zip files (right click, download linked file)
#### Make github release
- `git push origin MA.JOR-branch && git push --tags` (or magit `P p`, `P t`)