Skip to content

Latest commit

 

History

History
72 lines (53 loc) · 3.17 KB

release-process.md

File metadata and controls

72 lines (53 loc) · 3.17 KB

Bitcoin ABC Release Process

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
    • 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.

  3. Update the documents / code which needs to be updated every release

    • Check that doc/release-notes.md is complete, and fill in any missing items.
    • Update bips.md to account for changes since the last release.
    • (major releases) Update BLOCK_CHAIN_SIZE to the current size plus some overhead.
    • Update src/chainparams.cpp defaultAssumeValid and nMinimumChainWork with information from the getblockhash rpc.
      • The selected value must not be orphaned so it may be useful to set the value two blocks back from the tip.
      • Testnet should be set some tens of thousands back from the tip due to reorgs there.
      • This update should be reviewed with a reindex-chainstate with assumevalid=0 to catch any defect that causes rejection of blocks in the past history.
    • 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.

  4. Add git tag for release

  5. Increment version number for the next release in:

    • doc/release-notes.md (and copy existing one to versioned doc/release-notes/*.md)
    • configure.ac
    • src/config/CMakeLists.txt
    • contrib/gitian-descriptors/*.yml (before a new major release)
    • contrib/seeds/makeseeds.py (only after a new major release)

Release

  1. Create Gitian Builds (see gitian-building.md)

  2. Verify matching Gitian Builds, gather signatures

  3. Verify IBD bith with and without -checkpoints=0 -assumevalid=0

  4. Upload Gitian Builds to bitcoinabc.org

  5. Create a GitHub release. The Github release name should be the same as the tag (without the prepended 'v'), and the contents of the release notes should be copied from release-notes.md.

  6. Notify maintainers of Ubuntu PPA, AUR, and Docker images to build their packages. They should be given 1-day advance notice if possible.

After Release

  1. Update version number on www.bitcoinabc.org

  2. Publish signed checksums (various places, e.g. blog, reddit/r/BitcoinABC)

  3. Announce Release:

    • Reddit
    • Twitter @Bitcoin_ABC
    • Public slack channels friendly to Bitcoin ABC announcements (eg. #abc-announce on BTCforks, #hardfork on BTCchat)