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

;doc: releasing: updates

Browse Source
This commit is contained in:
Simon Michael 2021-07-28 09:22:00 -10:00
parent e4a23c95d4
commit 13fbd83626
1 changed files with 29 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
RELEASING.md
View File

@ -4,8 +4,8 @@ Guidance for release managers and maintainers.
Terminology:
- "main" = the master branch, might get renamed in future.
- "release" = a release branch, such as 1.22.
- "main" = the `master` branch in the main hledger repo (might be renamed to main in future).
- "release" = a release branch in the main hledger repo, such as `1.22`.
## Changelogs
@ -21,28 +21,34 @@ Use `./Shake changelogs` to update them from recent commit messages.
Checklist:
- create release branch if none\
1. create release branch if none\
`git branch RELEASEBRANCH RELEASETAG`\
`git branch 1.22-branch 1.22`
- update main changelogs\
- `./Shake changelogs`
- do at least basic editing - drop things, move things
- `./Shake changelogs -c`
- review changes so far, estimate which packages will be released
- add "unreleased" minor release heading in main changelogs, immediately above previous release heading
```
# LATESTHASH
...CHANGES...
1. update main changelogs
- `./Shake changelogs`
- do at least basic editing - drop things, move things
- `./Shake changelogs -c`
# X.Y.1 unreleased <- new heading
1. review changes so far, estimate which packages will be released
# X.Y YYYY-MM-DD
```
- cherry pick changes to release
1. always update main changelogs first
2. cherry pick commits
3. move corresponding change items under minor release heading in main changelogs
- finalise release
- add date to minor release heading in main changelogs
- copy the minor release section from main changelogs to release changelogs
1. add "unreleased" minor release heading in main changelogs, immediately above previous release heading
```
# LATESTHASH
...
# X.Y.1 unreleased <- new heading
# X.Y YYYY-MM-DD
```
1. cherry pick changes to release
1. always update main changelogs first
2. cherry pick minor-release-worthy commits
- don't cherry pick changelog commits, "dev: doc: update ..."
3. in main changelogs, move corresponding change items under minor release heading
1. finalise release
- add date to minor release heading in main changelogs
- copy the minor release section from main changelogs to release changelogs