diff --git a/doc/release-process.md b/doc/release-process.md --- a/doc/release-process.md +++ b/doc/release-process.md @@ -4,35 +4,28 @@ ## Before Release -1. Check configuration - - Check features planned for the release are implemented and documented - (or more informally, that the Release Manager agrees it is feature complete) - - Check that finished tasks / tickets are marked as resolved - -2. Verify tests passed - - Any known issues or limitations should be documented in release notes +1. Check feature completeness + - Check features planned for the release are implemented and documented. + Any incomplete items should be discussed with the Release Manager as soon as possible. - Known bugs should have tickets - - Run `arc lint --everything` and check there is no linter error - - Ensure that bitcoind and bitcoin-qt run with no issue on all supported platforms. - Manually test bitcoin-qt by sending some transactions and navigating through the menus. + - Any known issues or limitations should be documented in release notes -3. Update the documents / code which needs to be updated every release +2. Update the documents / code which needs to be updated every release - Check that [release-notes.md](doc/release-notes.md) is complete, and fill in any missing items. - - Update [bips.md](/doc/bips.md) to account for changes since the last release. - - (major releases) Update [`BLOCK_CHAIN_SIZE`](/src/qt/intro.cpp) to the current size plus - some overhead. + - Verify the following were updated by automation since the last release: + - Seeds (see [README](contrib/seeds/README.md)) + - Chainparams were updated, such as assume-valid, chainwork, and disk size expectations. - Regenerate manpages (run `contrib/devtools/gen-manpages.sh`, or for out-of-tree builds run `BUILDDIR=$PWD/build contrib/devtools/gen-manpages.sh`). - - Update seeds as per [contrib/seeds/README.md](/contrib/seeds/README.md). - - Update [`src/chainparams.cpp`](/src/chainparams.cpp) m_assumed_blockchain_size and m_assumed_chain_state_size with the current size plus some overhead. + +3. Verify tests passed + - Run `arc lint --everything` and check there is no linter error + - Ensure that bitcoind and bitcoin-qt run with no issue on all supported platforms. + Manually test bitcoin-qt by sending some transactions and navigating through the menus. 4. Add git tag for release a. Create the tag: `git tag vM.m.r` (M = major version, m = minor version, r = revision) - b. Push the tag to Github: - ``` - git push master - git push vM.m.r - ``` + b. Push the tag to Github: `git push vM.m.r` 5. Increment version number for the next release in: - `doc/release-notes.md` (and copy existing one to versioned `doc/release-notes/*.md`) @@ -46,7 +39,7 @@ 7. Verify matching Gitian Builds, gather signatures -8. Verify IBD bith with and without `-checkpoints=0 -assumevalid=0` +8. Verify IBD both with and without `-checkpoints=0 -assumevalid=0` 9. Upload Gitian Builds to [bitcoinabc.org](https://download.bitcoinabc.org/) @@ -61,11 +54,9 @@ ## After Release -13. Update version number on www.bitcoinabc.org - -14. Publish signed checksums (various places, e.g. blog, reddit/r/BitcoinABC) +13. Publish signed checksums (various places, e.g. blog, reddit/r/BitcoinABC) -15. Announce Release: +14. Announce Release: - [Reddit](https://www.reddit.com/r/BitcoinABC/) - Twitter @Bitcoin_ABC - Public slack channels friendly to Bitcoin ABC announcements