doc/release-process.md

   1 Release Process
   2 ====================
   3
   4 * update translations (ping wumpus, Diapolo or tcatm on IRC)
   5 * see https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#syncing-with-transifex
   6
   7 * * *
   8
   9 ###update (commit) version in sources
  10
  11         contrib/verifysfbinaries/verify.sh
  12         doc/README*
  13         share/setup.nsi
  14         src/clientversion.h (change CLIENT_VERSION_IS_RELEASE to true)
  15
  16 ###tag version in git
  17
  18         git tag -s v(new version, e.g. 0.8.0)
  19
  20 ###write release notes. git shortlog helps a lot, for example:
  21
  22         git shortlog --no-merges v(current version, e.g. 0.7.2)..v(new version, e.g. 0.8.0)
  23
  24 * * *
  25
  26 ###update gitian
  27
  28  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)
  29
  30 ###perform gitian builds
  31
  32  From a directory containing the bitcoin source, gitian-builder and gitian.sigs
  33
  34         export SIGNER=(your gitian key, ie bluematt, sipa, etc)
  35         export VERSION=(new version, e.g. 0.8.0)
  36         pushd ./bitcoin
  37         git checkout v${VERSION}
  38         popd
  39         pushd ./gitian-builder
  40
  41 ###fetch and build inputs: (first time, or when dependency versions change)
  42
  43         mkdir -p inputs
  44
  45  Register and download the Apple SDK: (see OSX Readme for details)
  46
  47  https://developer.apple.com/downloads/download.action?path=Developer_Tools/xcode_6.1.1/xcode_6.1.1.dmg
  48
  49  Using a Mac, create a tarball for the 10.9 SDK and copy it to the inputs directory:
  50
  51         tar -C /Volumes/Xcode/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/ -czf MacOSX10.9.sdk.tar.gz MacOSX10.9.sdk
  52
  53 ###Optional: Seed the Gitian sources cache
  54
  55   By default, gitian will fetch source files as needed. For offline builds, they can be fetched ahead of time:
  56
  57         make -C ../bitcoin/depends download SOURCES_PATH=`pwd`/cache/common
  58
  59   Only missing files will be fetched, so this is safe to re-run for each build.
  60
  61 ###Build Bitcoin Core for Linux, Windows, and OS X:
  62
  63         ./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml
  64         ./bin/gsign --signer $SIGNER --release ${VERSION}-linux --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml
  65         mv build/out/bitcoin-*.tar.gz build/out/src/bitcoin-*.tar.gz ../
  66         ./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-win.yml
  67         ./bin/gsign --signer $SIGNER --release ${VERSION}-win --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-win.yml
  68         mv build/out/bitcoin-*.zip build/out/bitcoin-*.exe ../
  69         ./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-osx.yml
  70         ./bin/gsign --signer $SIGNER --release ${VERSION}-osx-unsigned --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-osx.yml
  71         mv build/out/bitcoin-*-unsigned.tar.gz inputs/bitcoin-osx-unsigned.tar.gz
  72         mv build/out/bitcoin-*.tar.gz build/out/bitcoin-*.dmg ../
  73         popd
  74   Build output expected:
  75
  76   1. source tarball (bitcoin-${VERSION}.tar.gz)
  77   2. linux 32-bit and 64-bit binaries dist tarballs (bitcoin-${VERSION}-linux[32|64].tar.gz)
  78   3. windows 32-bit and 64-bit installers and dist zips (bitcoin-${VERSION}-win[32|64]-setup.exe, bitcoin-${VERSION}-win[32|64].zip)
  79   4. OSX unsigned installer (bitcoin-${VERSION}-osx-unsigned.dmg)
  80   5. Gitian signatures (in gitian.sigs/${VERSION}-<linux|win|osx-unsigned>/(your gitian key)/
  81
  82 ###Next steps:
  83
  84 Commit your signature to gitian.sigs:
  85
  86         pushd gitian.sigs
  87         git add ${VERSION}-linux/${SIGNER}
  88         git add ${VERSION}-win/${SIGNER}
  89         git add ${VERSION}-osx-unsigned/${SIGNER}
  90         git commit -a
  91         git push  # Assuming you can push to the gitian.sigs tree
  92         popd
  93
  94   Wait for OSX detached signature:
  95         Once the OSX build has 3 matching signatures, Gavin will sign it with the apple App-Store key.
  96         He will then upload a detached signature to be combined with the unsigned app to create a signed binary.
  97
  98   Create the signed OSX binary:
  99
 100         pushd ./gitian-builder
 101         # Fetch the signature as instructed by Gavin
 102         cp signature.tar.gz inputs/
 103         ./bin/gbuild -i ../bitcoin/contrib/gitian-descriptors/gitian-osx-signer.yml
 104         ./bin/gsign --signer $SIGNER --release ${VERSION}-osx-signed --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-osx-signer.yml
 105         mv build/out/bitcoin-osx-signed.dmg ../bitcoin-${VERSION}-osx.dmg
 106         popd
 107
 108 Commit your signature for the signed OSX binary:
 109
 110         pushd gitian.sigs
 111         git add ${VERSION}-osx-signed/${SIGNER}
 112         git commit -a
 113         git push  # Assuming you can push to the gitian.sigs tree
 114         popd
 115
 116 -------------------------------------------------------------------------
 117
 118 ### After 3 or more people have gitian-built and their results match:
 119
 120 - Perform code-signing.
 121
 122     - Code-sign Windows -setup.exe (in a Windows virtual machine using signtool)
 123
 124   Note: only Gavin has the code-signing keys currently.
 125
 126 - Create `SHA256SUMS.asc` for the builds, and GPG-sign it:
 127 ```bash
 128 sha256sum * > SHA256SUMS
 129 gpg --digest-algo sha256 --clearsign SHA256SUMS # outputs SHA256SUMS.asc
 130 rm SHA256SUMS
 131 ```
 132 (the digest algorithm is forced to sha256 to avoid confusion of the `Hash:` header that GPG adds with the SHA256 used for the files)
 133 Note: check that SHA256SUMS itself doesn't end up in SHA256SUMS, which is a spurious/nonsensical entry.
 134
 135 - Upload zips and installers, as well as `SHA256SUMS.asc` from last step, to the bitcoin.org server
 136   into `/var/www/bin/bitcoin-core-${VERSION}`
 137
 138 - Update bitcoin.org version
 139
 140   - First, check to see if the Bitcoin.org maintainers have prepared a
 141     release: https://github.com/bitcoin/bitcoin.org/labels/Releases
 142
 143       - If they have, it will have previously failed their Travis CI
 144         checks because the final release files weren't uploaded.
 145         Trigger a Travis CI rebuild---if it passes, merge.
 146
 147   - If they have not prepared a release, follow the Bitcoin.org release
 148     instructions: https://github.com/bitcoin/bitcoin.org#release-notes
 149
 150   - After the pull request is merged, the website will automatically show the newest version within 15 minutes, as well
 151     as update the OS download links. Ping @saivann/@harding (saivann/harding on Freenode) in case anything goes wrong
 152
 153 - Announce the release:
 154
 155   - Release sticky on bitcointalk: https://bitcointalk.org/index.php?board=1.0
 156
 157   - Bitcoin-development mailing list
 158
 159   - Update title of #bitcoin on Freenode IRC
 160
 161   - Optionally reddit /r/Bitcoin, ... but this will usually sort out itself
 162
 163 - Notify BlueMatt so that he can start building [https://launchpad.net/~bitcoin/+archive/ubuntu/bitcoin](the PPAs)
 164
 165 - Add release notes for the new version to the directory `doc/release-notes` in git master
 166
 167 - Celebrate