doc/release-process.md

   1 Release Process
   2 ====================
   3
   4 * Update translations (ping wumpus, Diapolo or tcatm on IRC) see [translation_process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#syncing-with-transifex)
   5 * Update [bips.md](bips.md) to account for changes since the last release.
   6
   7 * * *
   8
   9 ###First time / New builders
  10 Check out the source code in the following directory hierarchy.
  11
  12         cd /path/to/your/toplevel/build
  13         git clone https://github.com/bitcoin/gitian.sigs.git
  14         git clone https://github.com/bitcoin/bitcoin-detached-sigs.git
  15         git clone https://github.com/devrandom/gitian-builder.git
  16         git clone https://github.com/bitcoin/bitcoin.git
  17
  18 ###Bitcoin maintainers/release engineers, update (commit) version in sources
  19
  20         pushd ./bitcoin
  21         contrib/verifysfbinaries/verify.sh
  22         doc/README*
  23         share/setup.nsi
  24         src/clientversion.h (change CLIENT_VERSION_IS_RELEASE to true)
  25
  26         # tag version in git
  27
  28         git tag -s v(new version, e.g. 0.8.0)
  29
  30         # write release notes. git shortlog helps a lot, for example:
  31
  32         git shortlog --no-merges v(current version, e.g. 0.7.2)..v(new version, e.g. 0.8.0)
  33         popd
  34
  35 * * *
  36
  37 ###Setup and perform Gitian builds
  38
  39  Setup Gitian descriptors:
  40
  41         pushd ./bitcoin
  42         export SIGNER=(your Gitian key, ie bluematt, sipa, etc)
  43         export VERSION=(new version, e.g. 0.8.0)
  44         git checkout v${VERSION}
  45         popd
  46
  47   Ensure your gitian.sigs are up-to-date if you wish to gverify your builds against other Gitian signatures.
  48
  49         pushd ./gitian.sigs
  50         git pull
  51         popd
  52
  53   Ensure gitian-builder is up-to-date to take advantage of new caching features (`e9741525c` or later is recommended).
  54
  55         pushd ./gitian-builder
  56         git pull
  57
  58 ###Fetch and create inputs: (first time, or when dependency versions change)
  59
  60         mkdir -p inputs
  61         wget -P inputs https://bitcoincore.org/cfields/osslsigncode-Backports-to-1.7.1.patch
  62         wget -P inputs http://downloads.sourceforge.net/project/osslsigncode/osslsigncode/osslsigncode-1.7.1.tar.gz
  63
  64  Register and download the Apple SDK: see [OS X readme](README_osx.txt) for details.
  65
  66  https://developer.apple.com/devcenter/download.action?path=/Developer_Tools/xcode_6.1.1/xcode_6.1.1.dmg
  67
  68  Using a Mac, create a tarball for the 10.9 SDK and copy it to the inputs directory:
  69
  70         tar -C /Volumes/Xcode/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/ -czf MacOSX10.9.sdk.tar.gz MacOSX10.9.sdk
  71
  72 ###Optional: Seed the Gitian sources cache and offline git repositories
  73
  74 By default, Gitian will fetch source files as needed. To cache them ahead of time:
  75
  76         make -C ../bitcoin/depends download SOURCES_PATH=`pwd`/cache/common
  77
  78 Only missing files will be fetched, so this is safe to re-run for each build.
  79
  80 NOTE: Offline builds must use the --url flag to ensure Gitian fetches only from local URLs. For example:
  81 ```
  82 ./bin/gbuild --url bitcoin=/path/to/bitcoin,signature=/path/to/sigs {rest of arguments}
  83 ```
  84 The gbuild invocations below <b>DO NOT DO THIS</b> by default.
  85
  86 ###Build (and optionally verify) Bitcoin Core for Linux, Windows, and OS X:
  87
  88         ./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml
  89         ./bin/gsign --signer $SIGNER --release ${VERSION}-linux --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml
  90         ./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-linux ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml
  91         mv build/out/bitcoin-*.tar.gz build/out/src/bitcoin-*.tar.gz ../
  92
  93         ./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-win.yml
  94         ./bin/gsign --signer $SIGNER --release ${VERSION}-win-unsigned --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-win.yml
  95         ./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-win-unsigned ../bitcoin/contrib/gitian-descriptors/gitian-win.yml
  96         mv build/out/bitcoin-*-win-unsigned.tar.gz inputs/bitcoin-win-unsigned.tar.gz
  97         mv build/out/bitcoin-*.zip build/out/bitcoin-*.exe ../
  98
  99         ./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-osx.yml
 100         ./bin/gsign --signer $SIGNER --release ${VERSION}-osx-unsigned --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-osx.yml
 101         ./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-osx-unsigned ../bitcoin/contrib/gitian-descriptors/gitian-osx.yml
 102         mv build/out/bitcoin-*-osx-unsigned.tar.gz inputs/bitcoin-osx-unsigned.tar.gz
 103         mv build/out/bitcoin-*.tar.gz build/out/bitcoin-*.dmg ../
 104         popd
 105
 106   Build output expected:
 107
 108   1. source tarball (bitcoin-${VERSION}.tar.gz)
 109   2. linux 32-bit and 64-bit dist tarballs (bitcoin-${VERSION}-linux[32|64].tar.gz)
 110   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)
 111   4. OS X unsigned installer and dist tarball (bitcoin-${VERSION}-osx-unsigned.dmg, bitcoin-${VERSION}-osx64.tar.gz)
 112   5. Gitian signatures (in gitian.sigs/${VERSION}-<linux|{win,osx}-unsigned>/(your Gitian key)/
 113
 114 ###Next steps:
 115
 116 Commit your signature to gitian.sigs:
 117
 118         pushd gitian.sigs
 119         git add ${VERSION}-linux/${SIGNER}
 120         git add ${VERSION}-win-unsigned/${SIGNER}
 121         git add ${VERSION}-osx-unsigned/${SIGNER}
 122         git commit -a
 123         git push  # Assuming you can push to the gitian.sigs tree
 124         popd
 125
 126   Wait for Windows/OS X detached signatures:
 127
 128         Once the Windows/OS X builds each have 3 matching signatures, they will be signed with their respective release keys.
 129         Detached signatures will then be committed to the [bitcoin-detached-sigs](https://github.com/bitcoin/bitcoin-detached-sigs) repository, which can be combined with the unsigned apps to create signed binaries.
 130
 131   Create (and optionally verify) the signed OS X binary:
 132
 133         pushd ./gitian-builder
 134         ./bin/gbuild -i --commit signature=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-osx-signer.yml
 135         ./bin/gsign --signer $SIGNER --release ${VERSION}-osx-signed --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-osx-signer.yml
 136         ./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-osx-signed ../bitcoin/contrib/gitian-descriptors/gitian-osx-signer.yml
 137         mv build/out/bitcoin-osx-signed.dmg ../bitcoin-${VERSION}-osx.dmg
 138         popd
 139
 140   Create (and optionally verify) the signed Windows binaries:
 141
 142         pushd ./gitian-builder
 143         ./bin/gbuild -i --commit signature=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-win-signer.yml
 144         ./bin/gsign --signer $SIGNER --release ${VERSION}-win-signed --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-win-signer.yml
 145         ./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-win-signed ../bitcoin/contrib/gitian-descriptors/gitian-win-signer.yml
 146         mv build/out/bitcoin-*win64-setup.exe ../bitcoin-${VERSION}-win64-setup.exe
 147         mv build/out/bitcoin-*win32-setup.exe ../bitcoin-${VERSION}-win32-setup.exe
 148         popd
 149
 150 Commit your signature for the signed OS X/Windows binaries:
 151
 152         pushd gitian.sigs
 153         git add ${VERSION}-osx-signed/${SIGNER}
 154         git add ${VERSION}-win-signed/${SIGNER}
 155         git commit -a
 156         git push  # Assuming you can push to the gitian.sigs tree
 157         popd
 158
 159 -------------------------------------------------------------------------
 160
 161 ### After 3 or more people have gitian-built and their results match:
 162
 163 - Create `SHA256SUMS.asc` for the builds, and GPG-sign it:
 164 ```bash
 165 sha256sum * > SHA256SUMS
 166 gpg --digest-algo sha256 --clearsign SHA256SUMS # outputs SHA256SUMS.asc
 167 rm SHA256SUMS
 168 ```
 169 (the digest algorithm is forced to sha256 to avoid confusion of the `Hash:` header that GPG adds with the SHA256 used for the files)
 170 Note: check that SHA256SUMS itself doesn't end up in SHA256SUMS, which is a spurious/nonsensical entry.
 171
 172 - Upload zips and installers, as well as `SHA256SUMS.asc` from last step, to the bitcoin.org server
 173   into `/var/www/bin/bitcoin-core-${VERSION}`
 174
 175 - Update bitcoin.org version
 176
 177   - First, check to see if the Bitcoin.org maintainers have prepared a
 178     release: https://github.com/bitcoin-dot-org/bitcoin.org/labels/Releases
 179
 180       - If they have, it will have previously failed their Travis CI
 181         checks because the final release files weren't uploaded.
 182         Trigger a Travis CI rebuild---if it passes, merge.
 183
 184   - If they have not prepared a release, follow the Bitcoin.org release
 185     instructions: https://github.com/bitcoin-dot-org/bitcoin.org#release-notes
 186
 187   - After the pull request is merged, the website will automatically show the newest version within 15 minutes, as well
 188     as update the OS download links. Ping @saivann/@harding (saivann/harding on Freenode) in case anything goes wrong
 189
 190 - Announce the release:
 191
 192   - Release sticky on bitcointalk: https://bitcointalk.org/index.php?board=1.0
 193
 194   - Bitcoin-development mailing list
 195
 196   - Update title of #bitcoin on Freenode IRC
 197
 198   - Optionally reddit /r/Bitcoin, ... but this will usually sort out itself
 199
 200 - Notify BlueMatt so that he can start building [https://launchpad.net/~bitcoin/+archive/ubuntu/bitcoin](the PPAs)
 201
 202 - Add release notes for the new version to the directory `doc/release-notes` in git master
 203
 204 - Celebrate