You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

release-process.md 6.4KB

Release Process


update (commit) version in sources

contrib/verifysfbinaries/verify.sh
doc/README*
share/setup.nsi
src/clientversion.h (change CLIENT_VERSION_IS_RELEASE to true)

tag version in git

git tag -s v(new version, e.g. 0.8.0)

write release notes. git shortlog helps a lot, for example:

git shortlog --no-merges v(current version, e.g. 0.7.2)..v(new version, e.g. 0.8.0)

update gitian

In order to take advantage of the new caching features in gitian, be sure to update to a recent version (e9741525c or higher is recommended)

perform gitian builds

From a directory containing the bitcoin source, gitian-builder and gitian.sigs

export SIGNER=(your gitian key, ie bluematt, sipa, etc)
export VERSION=(new version, e.g. 0.8.0)
pushd ./bitcoin
git checkout v${VERSION}
popd
pushd ./gitian-builder

fetch and build inputs: (first time, or when dependency versions change)

mkdir -p inputs

Register and download the Apple SDK: (see OSX Readme for details)

https://developer.apple.com/downloads/download.action?path=Developer_Tools/xcode_6.1.1/xcode_6.1.1.dmg

Using a Mac, create a tarball for the 10.9 SDK and copy it to the inputs directory:

tar -C /Volumes/Xcode/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/ -czf MacOSX10.9.sdk.tar.gz MacOSX10.9.sdk

Optional: Seed the Gitian sources cache

By default, gitian will fetch source files as needed. For offline builds, they can be fetched ahead of time:

make -C ../bitcoin/depends download SOURCES_PATH=`pwd`/cache/common

Only missing files will be fetched, so this is safe to re-run for each build.

Build Bitcoin Core for Linux, Windows, and OS X:

./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml
./bin/gsign --signer $SIGNER --release ${VERSION}-linux --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml
mv build/out/bitcoin-*.tar.gz build/out/src/bitcoin-*.tar.gz ../
./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-win.yml
./bin/gsign --signer $SIGNER --release ${VERSION}-win --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-win.yml
mv build/out/bitcoin-*.zip build/out/bitcoin-*.exe ../
./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-osx.yml
./bin/gsign --signer $SIGNER --release ${VERSION}-osx-unsigned --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-osx.yml
mv build/out/bitcoin-*-unsigned.tar.gz inputs/bitcoin-osx-unsigned.tar.gz
mv build/out/bitcoin-*.tar.gz build/out/bitcoin-*.dmg ../
popd

Build output expected:

  1. source tarball (bitcoin-${VERSION}.tar.gz)
  2. linux 32-bit and 64-bit binaries dist tarballs (bitcoin-${VERSION}-linux[32|64].tar.gz)
  3. windows 32-bit and 64-bit installers and dist zips (bitcoin-${VERSION}-win[32|64]-setup.exe, bitcoin-${VERSION}-win[32|64].zip)
  4. OSX unsigned installer (bitcoin-${VERSION}-osx-unsigned.dmg)
  5. Gitian signatures (in gitian.sigs/${VERSION}-/(your gitian key)/

Next steps:

Commit your signature to gitian.sigs:

pushd gitian.sigs
git add ${VERSION}-linux/${SIGNER}
git add ${VERSION}-win/${SIGNER}
git add ${VERSION}-osx-unsigned/${SIGNER}
git commit -a
git push  # Assuming you can push to the gitian.sigs tree
popd

Wait for OSX detached signature:

Once the OSX build has 3 matching signatures, Gavin will sign it with the apple App-Store key.
He will then upload a detached signature to be combined with the unsigned app to create a signed binary.

Create the signed OSX binary:

pushd ./gitian-builder
# Fetch the signature as instructed by Gavin
cp signature.tar.gz inputs/
./bin/gbuild -i ../bitcoin/contrib/gitian-descriptors/gitian-osx-signer.yml
./bin/gsign --signer $SIGNER --release ${VERSION}-osx-signed --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-osx-signer.yml
mv build/out/bitcoin-osx-signed.dmg ../bitcoin-${VERSION}-osx.dmg
popd

Commit your signature for the signed OSX binary:

pushd gitian.sigs
git add ${VERSION}-osx-signed/${SIGNER}
git commit -a
git push  # Assuming you can push to the gitian.sigs tree
popd

After 3 or more people have gitian-built and their results match:

  • Perform code-signing.

    • Code-sign Windows -setup.exe (in a Windows virtual machine using signtool)

Note: only Gavin has the code-signing keys currently.

  • Create SHA256SUMS.asc for the builds, and GPG-sign it:

    sha256sum * > SHA256SUMS
    gpg --digest-algo sha256 --clearsign SHA256SUMS # outputs SHA256SUMS.asc
    rm SHA256SUMS
    

    (the digest algorithm is forced to sha256 to avoid confusion of the Hash: header that GPG adds with the SHA256 used for the files) Note: check that SHA256SUMS itself doesn’t end up in SHA256SUMS, which is a spurious/nonsensical entry.

  • Upload zips and installers, as well as SHA256SUMS.asc from last step, to the bitcoin.org server into /var/www/bin/bitcoin-core-${VERSION}

  • Update bitcoin.org version

    • First, check to see if the Bitcoin.org maintainers have prepared a release: https://github.com/bitcoin/bitcoin.org/labels/Releases

      • 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 instructions: https://github.com/bitcoin/bitcoin.org#release-notes

    • 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

  • Announce the release:

    • Release sticky on bitcointalk: https://bitcointalk.org/index.php?board=1.0

    • Bitcoin-development mailing list

    • Update title of #bitcoin on Freenode IRC

    • Optionally reddit /r/Bitcoin, … but this will usually sort out itself

  • Notify BlueMatt so that he can start building https://launchpad.net/~bitcoin/+archive/ubuntu/bitcoin

  • Add release notes for the new version to the directory doc/release-notes in git master

  • Celebrate