2013-05-19 21:30:00 -07:00
Release Process
====================
2016-04-15 04:21:16 -07:00
Before every release candidate:
2016-06-11 21:59:02 -07:00
* Update translations (ping wumpus on IRC) see [translation_process.md ](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#synchronising-translations ).
2016-04-15 04:21:16 -07:00
2016-09-15 21:36:46 -07:00
* Update manpages, see [gen-manpages.sh ](https://github.com/bitcoin/bitcoin/blob/master/contrib/devtools/README.md#gen-manpagessh ).
2016-04-15 04:21:16 -07:00
Before every minor and major release:
2015-10-13 04:11:17 -07:00
* Update [bips.md ](bips.md ) to account for changes since the last release.
2017-04-05 00:48:48 -07:00
* Update version in `configure.ac` (don't forget to set `CLIENT_VERSION_IS_RELEASE` to `true` )
2016-04-15 04:21:16 -07:00
* Write release notes (see below)
2016-10-21 22:33:25 -07:00
* Update `src/chainparams.cpp` nMinimumChainWork with information from the getblockchaininfo rpc.
2018-01-28 04:14:54 -08:00
* Update `src/chainparams.cpp` defaultAssumeValid with information from the getblockhash rpc.
2017-01-06 03:49:59 -08:00
- 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.
2016-04-15 04:21:16 -07:00
Before every major release:
2013-05-19 21:30:00 -07:00
2016-06-11 21:59:02 -07:00
* Update hardcoded [seeds ](/contrib/seeds/README.md ), see [this pull request ](https://github.com/bitcoin/bitcoin/pull/7415 ) for an example.
2016-09-21 03:21:13 -07:00
* Update [`BLOCK_CHAIN_SIZE` ](/src/qt/intro.cpp ) to the current size plus some overhead.
2018-01-31 03:28:35 -08:00
* Update `src/chainparams.cpp` chainTxData with statistics about the transaction count and rate. Use the output of the RPC `getchaintxstats` , see
2018-01-31 10:47:06 -08:00
[this pull request ](https://github.com/bitcoin/bitcoin/pull/12270 ) for an example. Reviewers can verify the results by running `getchaintxstats <window_block_count> <window_last_block_hash>` with the `window_block_count` and `window_last_block_hash` from your output.
2017-04-05 00:48:48 -07:00
* Update version of `contrib/gitian-descriptors/*.yml` : usually one'd want to do this on master after branching off the release - but be sure to at least do it before a new major release
2016-04-15 04:21:16 -07:00
### First time / New builders
2013-05-19 21:30:00 -07:00
2016-09-22 06:14:19 -07:00
If you're using the automated script (found in [contrib/gitian-build.sh ](/contrib/gitian-build.sh )), then at this point you should run it with the "--setup" command. Otherwise ignore this.
2015-10-13 04:11:17 -07:00
Check out the source code in the following directory hierarchy.
2013-05-19 21:30:00 -07:00
2016-04-15 04:21:16 -07:00
cd /path/to/your/toplevel/build
2016-04-29 14:17:18 -07:00
git clone https://github.com/bitcoin-core/gitian.sigs.git
git clone https://github.com/bitcoin-core/bitcoin-detached-sigs.git
2016-04-15 04:21:16 -07:00
git clone https://github.com/devrandom/gitian-builder.git
git clone https://github.com/bitcoin/bitcoin.git
2017-04-05 00:48:48 -07:00
### Bitcoin maintainers/release engineers, suggestion for writing release notes
2015-09-17 14:17:26 -07:00
2016-04-15 04:21:16 -07:00
Write release notes. git shortlog helps a lot, for example:
2015-09-17 14:17:26 -07:00
2016-04-15 04:21:16 -07:00
git shortlog --no-merges v(current version, e.g. 0.7.2)..v(new version, e.g. 0.8.0)
2013-05-19 21:30:00 -07:00
2016-04-15 04:21:16 -07:00
(or ping @wumpus on IRC, he has specific tooling to generate the list of merged pulls
and sort them into categories based on labels)
2013-05-19 21:30:00 -07:00
2016-04-15 04:21:16 -07:00
Generate list of authors:
2013-05-19 21:30:00 -07:00
2016-04-15 04:21:16 -07:00
git log --format='%aN' "$*" | sort -ui | sed -e 's/^/- /'
2013-05-19 21:30:00 -07:00
2016-04-15 04:21:16 -07:00
Tag version (or release candidate) in git
2013-05-19 21:30:00 -07:00
2016-04-15 04:21:16 -07:00
git tag -s v(new version, e.g. 0.8.0)
2013-05-19 21:30:00 -07:00
2016-04-15 04:21:16 -07:00
### Setup and perform Gitian builds
2015-10-17 03:10:45 -07:00
2016-09-22 06:14:19 -07:00
If you're using the automated script (found in [contrib/gitian-build.sh ](/contrib/gitian-build.sh )), then at this point you should run it with the "--build" command. Otherwise ignore this.
2016-04-15 04:21:16 -07:00
Setup Gitian descriptors:
2014-08-12 16:24:05 -07:00
2016-04-15 04:21:16 -07:00
pushd ./bitcoin
2018-03-06 06:55:16 -08:00
export SIGNER="(your Gitian key, ie bluematt, sipa, etc)"
2016-04-15 04:21:16 -07:00
export VERSION=(new version, e.g. 0.8.0)
git fetch
git checkout v${VERSION}
popd
2015-09-17 14:17:26 -07:00
2016-04-15 04:21:16 -07:00
Ensure your gitian.sigs are up-to-date if you wish to gverify your builds against other Gitian signatures.
2015-09-17 14:17:26 -07:00
2016-04-15 04:21:16 -07:00
pushd ./gitian.sigs
git pull
popd
2015-09-17 14:17:26 -07:00
2016-06-11 21:59:02 -07:00
Ensure gitian-builder is up-to-date:
2015-09-17 14:17:26 -07:00
2016-04-15 04:21:16 -07:00
pushd ./gitian-builder
git pull
popd
2014-05-13 16:23:22 -07:00
2016-04-15 04:21:16 -07:00
### Fetch and create inputs: (first time, or when dependency versions change)
2015-10-17 03:10:45 -07:00
2016-04-15 04:21:16 -07:00
pushd ./gitian-builder
mkdir -p inputs
wget -P inputs https://bitcoincore.org/cfields/osslsigncode-Backports-to-1.7.1.patch
wget -P inputs http://downloads.sourceforge.net/project/osslsigncode/osslsigncode/osslsigncode-1.7.1.tar.gz
popd
2013-05-19 21:30:00 -07:00
2018-06-04 03:54:22 -07:00
Create the macOS SDK tarball, see the [macOS readme ](README_osx.md ) for details, and copy it into the inputs directory.
2013-05-19 21:30:00 -07:00
2016-04-15 04:21:16 -07:00
### Optional: Seed the Gitian sources cache and offline git repositories
2014-12-11 15:53:24 -08:00
2018-03-06 12:24:47 -08:00
NOTE: Gitian is sometimes unable to download files. If you have errors, try the step below.
By default, Gitian will fetch source files as needed. To cache them ahead of time, make sure you have checked out the tag you want to build in bitcoin, then:
2014-12-11 15:53:24 -08:00
2016-04-15 04:21:16 -07:00
pushd ./gitian-builder
make -C ../bitcoin/depends download SOURCES_PATH=`pwd`/cache/common
popd
2014-12-11 15:53:24 -08:00
2015-09-17 14:17:26 -07:00
Only missing files will be fetched, so this is safe to re-run for each build.
2015-10-17 03:10:45 -07:00
NOTE: Offline builds must use the --url flag to ensure Gitian fetches only from local URLs. For example:
2016-04-15 04:21:16 -07:00
pushd ./gitian-builder
./bin/gbuild --url bitcoin=/path/to/bitcoin,signature=/path/to/sigs {rest of arguments}
popd
2015-10-13 04:11:17 -07:00
The gbuild invocations below < b > DO NOT DO THIS< / b > by default.
2014-12-11 15:53:24 -08:00
2018-06-04 03:54:22 -07:00
### Build and sign Bitcoin Core for Linux, Windows, and macOS:
2015-10-17 03:10:45 -07:00
2016-04-15 04:21:16 -07:00
pushd ./gitian-builder
2017-07-30 23:32:47 -07:00
./bin/gbuild --num-make 2 --memory 3000 --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml
2018-03-06 06:55:16 -08:00
./bin/gsign --signer "$SIGNER" --release ${VERSION}-linux --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml
2015-12-25 04:09:26 -08:00
mv build/out/bitcoin-*.tar.gz build/out/src/bitcoin-*.tar.gz ../
2015-09-17 14:17:26 -07:00
2017-07-30 23:32:47 -07:00
./bin/gbuild --num-make 2 --memory 3000 --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-win.yml
2018-03-06 06:55:16 -08:00
./bin/gsign --signer "$SIGNER" --release ${VERSION}-win-unsigned --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-win.yml
2015-12-25 04:09:26 -08:00
mv build/out/bitcoin-*-win-unsigned.tar.gz inputs/bitcoin-win-unsigned.tar.gz
mv build/out/bitcoin-*.zip build/out/bitcoin-*.exe ../
2015-09-17 14:17:26 -07:00
2017-07-30 23:32:47 -07:00
./bin/gbuild --num-make 2 --memory 3000 --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-osx.yml
2018-03-06 06:55:16 -08:00
./bin/gsign --signer "$SIGNER" --release ${VERSION}-osx-unsigned --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-osx.yml
2015-12-25 04:09:26 -08:00
mv build/out/bitcoin-*-osx-unsigned.tar.gz inputs/bitcoin-osx-unsigned.tar.gz
mv build/out/bitcoin-*.tar.gz build/out/bitcoin-*.dmg ../
2016-04-15 04:21:16 -07:00
popd
2015-09-17 14:17:26 -07:00
2016-04-15 04:21:16 -07:00
Build output expected:
2013-05-19 21:30:00 -07:00
2016-04-15 04:21:16 -07:00
1. source tarball (`bitcoin-${VERSION}.tar.gz`)
2. linux 32-bit and 64-bit dist tarballs (`bitcoin-${VERSION}-linux[32|64].tar.gz`)
3. windows 32-bit and 64-bit unsigned installers and dist zips (`bitcoin-${VERSION}-win[32|64]-setup-unsigned.exe`, `bitcoin-${VERSION}-win[32|64].zip` )
2018-06-04 03:54:22 -07:00
4. macOS unsigned installer and dist tarball (`bitcoin-${VERSION}-osx-unsigned.dmg`, `bitcoin-${VERSION}-osx64.tar.gz` )
2016-04-15 04:21:16 -07:00
5. Gitian signatures (in `gitian.sigs/${VERSION}-<linux|{win,osx}-unsigned>/(your Gitian key)/` )
2014-09-27 11:47:12 -07:00
2016-04-15 04:21:16 -07:00
### Verify other gitian builders signatures to your own. (Optional)
2016-01-25 16:39:46 -08:00
2017-12-15 10:16:31 -08:00
Add other gitian builders keys to your gpg keyring, and/or refresh keys: See `../bitcoin/contrib/gitian-keys/README.md` .
2016-01-25 16:39:46 -08:00
2016-04-15 04:21:16 -07:00
Verify the signatures
2016-01-25 16:39:46 -08:00
2016-04-15 04:21:16 -07:00
pushd ./gitian-builder
./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-linux ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml
./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-win-unsigned ../bitcoin/contrib/gitian-descriptors/gitian-win.yml
./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-osx-unsigned ../bitcoin/contrib/gitian-descriptors/gitian-osx.yml
popd
2016-01-25 16:39:46 -08:00
2016-04-15 04:21:16 -07:00
### Next steps:
2013-05-19 21:30:00 -07:00
Commit your signature to gitian.sigs:
2016-04-15 04:21:16 -07:00
pushd gitian.sigs
2018-03-06 06:55:16 -08:00
git add ${VERSION}-linux/"${SIGNER}"
git add ${VERSION}-win-unsigned/"${SIGNER}"
git add ${VERSION}-osx-unsigned/"${SIGNER}"
2018-07-17 12:53:12 -07:00
git commit -m "Add ${VERSION} unsigned sigs for ${SIGNER}"
2016-04-15 04:21:16 -07:00
git push # Assuming you can push to the gitian.sigs tree
popd
2015-06-18 15:17:36 -07:00
2018-06-04 03:54:22 -07:00
Codesigner only: Create Windows/macOS detached signatures:
2017-01-10 16:16:28 -08:00
- Only one person handles codesigning. Everyone else should skip to the next step.
2018-06-04 03:54:22 -07:00
- Only once the Windows/macOS builds each have 3 matching signatures may they be signed with their respective release keys.
2017-01-10 16:16:28 -08:00
2018-06-04 03:54:22 -07:00
Codesigner only: Sign the macOS binary:
2017-01-10 16:16:28 -08:00
2018-06-04 03:54:22 -07:00
transfer bitcoin-osx-unsigned.tar.gz to macOS for signing
2017-01-10 16:16:28 -08:00
tar xf bitcoin-osx-unsigned.tar.gz
./detached-sig-create.sh -s "Key ID"
Enter the keychain password and authorize the signature
Move signature-osx.tar.gz back to the gitian host
Codesigner only: Sign the windows binaries:
tar xf bitcoin-win-unsigned.tar.gz
./detached-sig-create.sh -key /path/to/codesign.key
Enter the passphrase for the key when prompted
signature-win.tar.gz will be created
Codesigner only: Commit the detached codesign payloads:
cd ~/bitcoin-detached-sigs
checkout the appropriate branch for this release series
rm -rf *
tar xf signature-osx.tar.gz
tar xf signature-win.tar.gz
git add -a
git commit -m "point to ${VERSION}"
git tag -s v${VERSION} HEAD
git push the current branch and new tag
2018-06-04 03:54:22 -07:00
Non-codesigners: wait for Windows/macOS detached signatures:
2016-04-15 04:21:16 -07:00
2018-06-04 03:54:22 -07:00
- Once the Windows/macOS builds each have 3 matching signatures, they will be signed with their respective release keys.
2016-04-29 14:17:18 -07:00
- Detached signatures will then be committed to the [bitcoin-detached-sigs ](https://github.com/bitcoin-core/bitcoin-detached-sigs ) repository, which can be combined with the unsigned apps to create signed binaries.
2016-04-15 04:21:16 -07:00
2018-06-04 03:54:22 -07:00
Create (and optionally verify) the signed macOS binary:
2014-11-25 16:23:18 -08:00
2016-04-15 04:21:16 -07:00
pushd ./gitian-builder
./bin/gbuild -i --commit signature=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-osx-signer.yml
2018-03-06 06:55:16 -08:00
./bin/gsign --signer "$SIGNER" --release ${VERSION}-osx-signed --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-osx-signer.yml
2016-04-15 04:21:16 -07:00
./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-osx-signed ../bitcoin/contrib/gitian-descriptors/gitian-osx-signer.yml
mv build/out/bitcoin-osx-signed.dmg ../bitcoin-${VERSION}-osx.dmg
popd
2013-05-19 21:30:00 -07:00
2016-04-15 04:21:16 -07:00
Create (and optionally verify) the signed Windows binaries:
pushd ./gitian-builder
./bin/gbuild -i --commit signature=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-win-signer.yml
2018-03-06 06:55:16 -08:00
./bin/gsign --signer "$SIGNER" --release ${VERSION}-win-signed --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-win-signer.yml
2016-04-15 04:21:16 -07:00
./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-win-signed ../bitcoin/contrib/gitian-descriptors/gitian-win-signer.yml
mv build/out/bitcoin-*win64-setup.exe ../bitcoin-${VERSION}-win64-setup.exe
mv build/out/bitcoin-*win32-setup.exe ../bitcoin-${VERSION}-win32-setup.exe
popd
2018-06-04 03:54:22 -07:00
Commit your signature for the signed macOS/Windows binaries:
2016-04-15 04:21:16 -07:00
pushd gitian.sigs
2018-03-06 06:55:16 -08:00
git add ${VERSION}-osx-signed/"${SIGNER}"
git add ${VERSION}-win-signed/"${SIGNER}"
2016-04-15 04:21:16 -07:00
git commit -a
git push # Assuming you can push to the gitian.sigs tree
popd
2013-05-19 21:30:00 -07:00
2014-08-04 00:47:59 -07:00
### After 3 or more people have gitian-built and their results match:
2013-05-19 21:30:00 -07:00
2014-09-27 06:58:47 -07:00
- Create `SHA256SUMS.asc` for the builds, and GPG-sign it:
2016-04-15 04:21:16 -07:00
2014-09-27 06:58:47 -07:00
```bash
sha256sum * > SHA256SUMS
2016-04-15 04:21:16 -07:00
```
The list of files should be:
```
2016-06-21 05:10:53 -07:00
bitcoin-${VERSION}-aarch64-linux-gnu.tar.gz
bitcoin-${VERSION}-arm-linux-gnueabihf.tar.gz
bitcoin-${VERSION}-i686-pc-linux-gnu.tar.gz
bitcoin-${VERSION}-x86_64-linux-gnu.tar.gz
2016-04-15 04:21:16 -07:00
bitcoin-${VERSION}-osx64.tar.gz
bitcoin-${VERSION}-osx.dmg
bitcoin-${VERSION}.tar.gz
bitcoin-${VERSION}-win32-setup.exe
bitcoin-${VERSION}-win32.zip
bitcoin-${VERSION}-win64-setup.exe
bitcoin-${VERSION}-win64.zip
```
2016-06-21 05:10:53 -07:00
The `*-debug*` files generated by the gitian build contain debug symbols
for troubleshooting by developers. It is assumed that anyone that is interested
in debugging can run gitian to generate the files for themselves. To avoid
end-user confusion about which file to pick, as well as save storage
space *do not upload these to the bitcoin.org server, nor put them in the torrent* .
2016-04-15 04:21:16 -07:00
- GPG-sign it, delete the unsigned file:
```
2014-09-29 07:58:30 -07:00
gpg --digest-algo sha256 --clearsign SHA256SUMS # outputs SHA256SUMS.asc
2014-09-27 06:58:47 -07:00
rm SHA256SUMS
2014-08-04 00:47:59 -07:00
```
2014-09-29 07:58:30 -07:00
(the digest algorithm is forced to sha256 to avoid confusion of the `Hash:` header that GPG adds with the SHA256 used for the files)
2015-02-16 01:37:13 -08:00
Note: check that SHA256SUMS itself doesn't end up in SHA256SUMS, which is a spurious/nonsensical entry.
2014-08-04 00:47:59 -07:00
- Upload zips and installers, as well as `SHA256SUMS.asc` from last step, to the bitcoin.org server
2015-04-02 22:51:31 -07:00
into `/var/www/bin/bitcoin-core-${VERSION}`
2014-08-04 00:47:59 -07:00
2016-04-15 04:21:16 -07:00
- A `.torrent` will appear in the directory after a few minutes. Optionally help seed this torrent. To get the `magnet:` URI use:
```bash
transmission-show -m < torrent file >
```
Insert the magnet URI into the announcement sent to mailing lists. This permits
people without access to `bitcoin.org` to download the binary distribution.
Also put it into the `optional_magnetlink:` slot in the YAML file for
2016-06-11 21:59:02 -07:00
bitcoin.org (see below for bitcoin.org update instructions).
2016-04-15 04:21:16 -07:00
2014-08-04 00:47:59 -07:00
- Update bitcoin.org version
2015-04-02 22:51:31 -07:00
- First, check to see if the Bitcoin.org maintainers have prepared a
2018-05-30 05:11:36 -07:00
release: https://github.com/bitcoin-dot-org/bitcoin.org/labels/Core
2014-08-04 00:47:59 -07:00
2015-04-02 22:51:31 -07:00
- If they have, it will have previously failed their Travis CI
checks because the final release files weren't uploaded.
Trigger a Travis CI rebuild---if it passes, merge.
- If they have not prepared a release, follow the Bitcoin.org release
2018-05-30 05:11:36 -07:00
instructions: https://github.com/bitcoin-dot-org/bitcoin.org/blob/master/docs/adding-events-release-notes-and-alerts.md#release-notes
2015-04-02 22:51:31 -07:00
- After the pull request is merged, the website will automatically show the newest version within 15 minutes, as well
as update the OS download links. Ping @saivann/@harding (saivann/harding on Freenode) in case anything goes wrong
2014-08-04 00:47:59 -07:00
- Announce the release:
2013-12-10 00:57:30 -08:00
2016-04-15 04:21:16 -07:00
- bitcoin-dev and bitcoin-core-dev mailing list
- Bitcoin Core announcements list https://bitcoincore.org/en/list/announcements/join/
2013-12-10 00:57:30 -08:00
2016-04-15 04:21:16 -07:00
- bitcoincore.org blog post
2013-12-10 00:57:30 -08:00
2014-08-04 00:47:59 -07:00
- Update title of #bitcoin on Freenode IRC
2016-04-15 04:21:16 -07:00
- Optionally twitter, reddit /r/Bitcoin, ... but this will usually sort out itself
2014-08-04 00:47:59 -07:00
2016-04-15 04:21:16 -07:00
- Notify BlueMatt so that he can start building [the PPAs ](https://launchpad.net/~bitcoin/+archive/ubuntu/bitcoin )
2014-08-04 00:47:59 -07:00
2016-11-07 02:08:13 -08:00
- Archive release notes for the new version to `doc/release-notes/` (branch `master` and branch of the release)
- Create a [new GitHub release ](https://github.com/bitcoin/bitcoin/releases/new ) with a link to the archived release notes.
2013-12-10 00:57:30 -08:00
2016-04-15 04:21:16 -07:00
- Celebrate