simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-12-27 12:24:43 +03:00
Code Issues Projects Releases Wiki Activity

;doc: RELEASING updates

Browse Source 
many more needed..
This commit is contained in:
Simon Michael 2023-03-11 14:35:48 -10:00
parent a3aebb96e4
commit 3ac64a86e7
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

@ -9,10 +9,13 @@ Notes for hledger release managers and maintainers.
## Goals ## Goals
### 2023
- [ ] Make releasing easy
### 2022 ### 2022
- Update/consolidate release process docs - [x] Update/consolidate release process docs
- Establish routine monthly release cadence - [x] Establish routine <s>monthly</s> release cadence
- Make releasing easy - [ ] Make releasing easy
## Release types ## Release types
| | Major&nbsp;release<br>A.B | Bugfix&nbsp;release<br>A.B.C | Fixup&nbsp;release<br>A.B.C.D | Preview&nbsp;release<br>A.B.99.D | | | Major&nbsp;release<br>A.B | Bugfix&nbsp;release<br>A.B.C | Fixup&nbsp;release<br>A.B.C.D | Preview&nbsp;release<br>A.B.99.D |
@ -193,7 +196,7 @@ In release branch:
#### Do release build testing #### Do release build testing
- touch/change Version.hs to encourage recompilation - touch/change Version.hs to encourage recompilation
- `stack build` - `stack build`
- `stack exec -- hledger --version`, check version string: version, release date, no + - `stack exec -- hledger --version`, check version, hash, release date, no '+'
- `stack exec -- hledger help | tail`, check version, month matches release - `stack exec -- hledger help | tail`, check version, month matches release
#### Prepare release binaries #### Prepare release binaries
@ -208,10 +211,10 @@ In release branch:
In site repo: In site repo:
- js/site.js: add NEW, three places - js/site.js: add NEW, 3 places
- Makefile: add NEW, three places - Makefile: add NEW, 2 places
- make snapshot-NEW (after ensuring main repo has been release-tagged)
- commit: `manuals: add NEW` - commit: `manuals: add NEW`
- make snapshot-NEW (after ensuring main repo has been release-tagged)
- push - push
#### Prepare hledger-install script #### Prepare hledger-install script
@ -244,7 +247,7 @@ In site repo:
update --version outputs (search: hledger --version) update --version outputs (search: hledger --version)
- final output line from `hledger test` (run in terminal for normal speed) - final output line from `hledger test` (run in terminal for normal speed)
- Total count from `make functest` - Total count from `make functest`
- commit: `download: NEW` - commit: `install: NEW`
#### Draft github release #### Draft github release
- copy text from previous similar release, https://github.com/simonmichael/hledger/releases - copy text from previous similar release, https://github.com/simonmichael/hledger/releases
@ -311,7 +314,7 @@ in main repo, release branch:
#### Bump master to next version #### Bump master to next version
(major release) (major release)
- `./Shake setversion MA.JOR.99 -c` - `./Shake setversion MA.JOR.99 -c`
- `./Shake cmdhelp -c` - `./Shake cmdhelp [-c]` (might be empty)
- `./Shake mandates` - `./Shake mandates`
- `./Shake manuals -c` - `./Shake manuals -c`