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 2022-06-04 19:52:39 +01:00
parent 39ed693d2b
commit 5d9a0616db
1 changed files with 22 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
RELEASING.md
View File

@ -110,6 +110,7 @@ Here are some definitions, useful eg when executing or automating release proced
- [tag the release](#tag-the-release) - [tag the release](#tag-the-release)
- [push to github](#push-to-github) - [push to github](#push-to-github)
- [make github release](#make-github-release) - [make github release](#make-github-release)
- [update master from release branch](#update-master-from-release-branch)
#### Check release readiness #### Check release readiness
- master's changelogs are up to date (see [CHANGELOGS](CHANGELOGS.html)) - master's changelogs are up to date (see [CHANGELOGS](CHANGELOGS.html))
@ -167,6 +168,12 @@ Here are some definitions, useful eg when executing or automating release proced
- github release testing (preview) - github release testing (preview)
- publish - publish
#### Update master from release branch
- switch back to master
- update master changelogs, merging final release changelog entries (see [CHANGELOGS](CHANGELOGS.html))
- cherry-pick other useful changes, such as `;doc: ANNOUNCE`
- after a major release: bump master to new dev version (`./Shake setversion -c A.B.99`)
### 2. Major release ### 2. Major release
- [make release notes](#make-release-notes) - [make release notes](#make-release-notes)
- [make announcement](#make-announcement) - [make announcement](#make-announcement)
@ -224,32 +231,27 @@ In site repo:
- Total count from `make functest` - Total count from `make functest`
- commit: `download: NEW` - commit: `download: NEW`
#### Add manuals to website #### Add new manuals to website
In site: In site repo:
- js/site.js: add NEW, update currentrelease - js/site.js: add NEW, update currentrelease
- Makefile: add NEW, two places - Makefile: add NEW, two places
- make snapshot-NEW - make snapshot-NEW (after ensuring main repo has been release-tagged)
- (cd src; rm current; ln -s NEW current) - commit: `makefile, js: update for NEW`
- commit/amend
- push - push
On hledger.org:
- in /etc/caddy/hledger.org:
- add `path` and `redir`s for NEW
- `systemctl reload caddy`
- in site/
- make clean all
- purge cloudflare cache
- browsers might still require shift-reload to see new manuals (safari)
#### Announce major release #### Announce major release
- push main repo
- push site download/relnotes updates - push site repo
- push master hledger-install update - deploy site changes
On hledger.org:
- in /etc/caddy/hledger.org:
- add `path` and `redir`s for NEW
- `systemctl reload caddy`
- in site/
- make clean all
- purge cloudflare cache
- browsers might still require shift-reload to see new manuals (safari)
- share release notes link, then markdown content, in #hledger chat - share release notes link, then markdown content, in #hledger chat
- send ANNOUNCE to hledger@googlegroups.com, haskell-cafe@googlegroups.com (major release) - send ANNOUNCE to hledger@googlegroups.com, haskell-cafe@googlegroups.com (major release)
or brief announcement to hledger@googlegroups.com (bugfix release) or brief announcement to hledger@googlegroups.com (bugfix release)
@ -270,7 +272,6 @@ On hledger.org:
- proceed as above, with MA.JOR.MINOR - proceed as above, with MA.JOR.MINOR
### 5. After a release ### 5. After a release
- [update master after release](#update-master-after-release)
- monitor packaging status, update install page - monitor packaging status, update install page
- docker - expect/merge PR - docker - expect/merge PR
- homebrew - expect badge to update soon - homebrew - expect badge to update soon
@ -280,12 +281,6 @@ On hledger.org:
- prepare followup releases if needed - prepare followup releases if needed
- update process docs and tools - update process docs and tools
#### Update master after release
- switch back to master
- update master changelogs, merging final release changelog entries (see [CHANGELOGS](CHANGELOGS.html))
- cherry-pick other useful changes, such as `;doc: ANNOUNCE`
- after a major release: bump master to new dev version (`./Shake setversion -c A.B.99`)
### Packaging ### Packaging
#### Update homebrew formula #### Update homebrew formula