diff --git a/doc/RELEASING.canvas b/doc/RELEASING.canvas index 277a2bb83..eb38f4dc8 100644 --- a/doc/RELEASING.canvas +++ b/doc/RELEASING.canvas @@ -3,7 +3,7 @@ {"type":"text","text":"Release binaries\n","id":"07112d859abf3940","x":-159,"y":370,"width":191,"height":50,"color":"#f58f00"}, {"type":"text","text":"Passing platform CIs","id":"4af91a6bc27a1008","x":-187,"y":450,"width":250,"height":60,"color":"#f58f00"}, {"type":"text","text":"Up-to-date help","id":"92dda98079ab4d1e","x":80,"y":1080,"width":191,"height":55,"color":"5"}, - {"type":"text","text":"Draft changelogs","id":"e8e90d5c5cc42241","x":-404,"y":1127,"width":200,"height":60,"color":"5"}, + {"type":"text","text":"Up-to-date changelogs","id":"e8e90d5c5cc42241","x":-404,"y":1127,"width":224,"height":60,"color":"5"}, {"type":"text","text":"Features, improvements, fixes","id":"1b38487f9fac1e2c","x":-206,"y":1270,"width":309,"height":60,"color":"6"}, {"type":"text","text":"Issues resolved","id":"d456a78257f44050","x":-603,"y":1330,"width":194,"height":60,"color":"6"}, {"type":"text","text":"PRs merged","id":"d2a05c9533d9d429","x":-383,"y":1300,"width":158,"height":60,"color":"6"}, @@ -11,12 +11,12 @@ {"type":"text","text":"Stackage packages","id":"616a03afb2dbd2ec","x":-591,"y":-10,"width":223,"height":60}, {"type":"text","text":"OS packages","id":"01b5ecae1b62b5f6","x":-702,"y":-140,"width":198,"height":60}, {"type":"text","text":"Release manuals\n(Major)","id":"005cc0245045e8b2","x":165,"y":100,"width":315,"height":80,"color":"1"}, - {"type":"text","text":"LEVEL 1 - DEV","id":"1e09c093e184f1ff","x":-1140,"y":1270,"width":280,"height":60,"color":"6"}, - {"type":"text","text":"LEVEL 2 - DOCUMENTED","id":"80cb496c45b89756","x":-1140,"y":940,"width":280,"height":60,"color":"5"}, - {"type":"text","text":"LEVEL 3 - RELEASE DOCS","id":"0a51f5cec92dcd0a","x":-1140,"y":540,"width":280,"height":60,"color":"#ffdd00"}, - {"type":"text","text":"LEVEL 4 - RELEASE READY","id":"62ae958cd2ff139c","x":-1140,"y":280,"width":280,"height":60,"color":"#f58f00"}, - {"type":"text","text":"LEVEL 6 - PUBLISHED","id":"6b0c017479931f0a","x":-1140,"y":-390,"width":280,"height":60,"color":"4"}, - {"type":"text","text":"LEVEL 7 - ANNOUNCED","id":"0813225d75c39151","x":-1140,"y":-550,"width":280,"height":60,"color":"#007508"}, + {"type":"text","text":"LEVEL 1 - DEV","id":"1e09c093e184f1ff","x":-940,"y":1270,"width":280,"height":60,"color":"6"}, + {"type":"text","text":"LEVEL 2 - TEST","id":"80cb496c45b89756","x":-940,"y":940,"width":280,"height":60,"color":"5"}, + {"type":"text","text":"LEVEL 3 - RELEASE DOCS","id":"0a51f5cec92dcd0a","x":-940,"y":540,"width":280,"height":60,"color":"#ffdd00"}, + {"type":"text","text":"LEVEL 4 - RELEASE READY","id":"62ae958cd2ff139c","x":-940,"y":280,"width":280,"height":60,"color":"#f58f00"}, + {"type":"text","text":"LEVEL 6 - PUBLISHED","id":"6b0c017479931f0a","x":-940,"y":-390,"width":280,"height":60,"color":"4"}, + {"type":"text","text":"LEVEL 7 - ANNOUNCED","id":"0813225d75c39151","x":-940,"y":-550,"width":280,"height":60,"color":"#007508"}, {"type":"text","text":"Website","id":"187d7edfa7e9f024","x":0,"y":-390,"width":155,"height":60,"color":"4"}, {"type":"text","text":"Delightful, effective, up-to-date, installed software","id":"4e0b7a1fbefa6360","x":-226,"y":-820,"width":476,"height":59}, {"type":"text","text":" Happy, empowered users","id":"31313a683cb9b5e1","x":-132,"y":-900,"width":287,"height":50}, @@ -34,9 +34,9 @@ {"type":"text","text":"Release notes\n(Major, bugfix)","id":"4626d11550a5dd82","x":-200,"y":541,"width":270,"height":60,"color":"#ffdd00"}, {"type":"text","text":"Release tag","id":"ee51d1acdb16f4ed","x":-151,"y":280,"width":172,"height":60,"color":"#f58f00"}, {"type":"text","text":"Github release","id":"48113316f596b226","x":-190,"y":140,"width":250,"height":60,"color":"1"}, - {"type":"text","text":"Passing tests & master CI","id":"cd072c3e5f37fc77","x":-204,"y":940,"width":284,"height":60,"color":"5"}, + {"type":"text","text":"Passing tests and CI","id":"cd072c3e5f37fc77","x":-204,"y":940,"width":284,"height":60,"color":"5"}, {"type":"text","text":"Up-to-date manuals","id":"c11b65fbcab6d67a","x":-172,"y":1108,"width":220,"height":50,"color":"5"}, - {"type":"text","text":"LEVEL 5 - RELEASED","id":"4c7d316dc60a406d","x":-1140,"y":100,"width":280,"height":60,"color":"1"} + {"type":"text","text":"LEVEL 5 - RELEASED","id":"4c7d316dc60a406d","x":-940,"y":100,"width":280,"height":60,"color":"1"} ], "edges":[ {"id":"1cbe2796fa62185f","fromNode":"52d90724c458c2d2","fromSide":"bottom","toNode":"2d971da3a664c356","toSide":"top"}, diff --git a/doc/RELEASING.md b/doc/RELEASING.md index de4c8d170..92023fb8a 100644 --- a/doc/RELEASING.md +++ b/doc/RELEASING.md @@ -99,9 +99,9 @@ These have complex interdependencies and sequencing constraints. Chunk, separate ### Map -Here's a map of the value flows/artifacts/dependencies in a hledger release. -To do a release, start at the bottom of the diagram and work upward -(and work downward through the procedures described below). +Here's a map of the value flows/artifacts/dependencies in a hledger release (arrows mean "depends on"). +To do a release, start at the bottom of the diagram and work up +(and work down through the procedures described below). [![release diagram](RELEASING.png)](RELEASING.png) @@ -121,21 +121,45 @@ To do a release, start at the bottom of the diagram and work upward ### LEVEL 1 - DEV #### Check dev readiness -- open issues -- open PRs -- personal notes & backlogs +- open issues (bugs), https://bugs.hledger.org +- open PRs, https://prs.hledger.org - project boards, https://github.com/simonmichael/hledger/projects?query=is%3Aopen - https://hledger.org/ROADMAP.html, https://hledger.org/BACKLOG.html +- personal notes & backlogs -### LEVEL 2 - DOCUMENTED +### LEVEL 2 - TEST -#### Update changelogs +#### Up-to-date cabal files +- `./Shake cabalfiles` +- if there are changes, `./Shake cabalfiles -c` + +#### Up-to-date help +- `./Shake cmdhelp` +- if there are changes, `./Shake cmdhelp -c` + +#### Up-to-date manuals +- `./Shake mandates` +- `./Shake manuals` +- if there are changes, `./Shake manuals -c` + +#### Up-to-date changelogs in main repo, master branch: -- `./Shake changelogs`, clean up CHANGES.md's, `./Shake changelogs -c` +- `./Shake changelogs` +- clean up the five `CHANGES.md`s +- `./Shake changelogs -c` +See also [CHANGELOGS](CHANGELOGS.md). -See also CHANGELOGS.md. +#### Passing tests and CI +- `make functest` +- `make test` +- `make bench` ? +- `make haddocktest` ? +- CI tests in github main repo + - push to a PR, wait for green + - or push to `simon` branch, wait for green at http://ci.hledger.org + - or `tools/push` (pushes to `simon`, then to `master`) -#### Check up to date +#### Check documented - master's changelogs are up to date (see [CHANGELOGS](CHANGELOGS.html)) - master or release branch is ready for release - clean and synced working copy @@ -150,7 +174,7 @@ See also CHANGELOGS.md. ### LEVEL 3 - RELEASE DOCS #### Copy RELEASING.md -- copy of RELEASING.md to RELEASING2.md; make updates in the copy +- copy of RELEASING.md to RELEASING_.md; make updates in the copy #### Prepare release branch Preview/major release: diff --git a/doc/RELEASING.png b/doc/RELEASING.png index c83e14487..44eb59a74 100644 Binary files a/doc/RELEASING.png and b/doc/RELEASING.png differ