doc/release-process.txt

   1 * update translations (ping tcatm on IRC for now)
   2
   3 * update (commit) version in sources
   4   bitcoin-qt.pro
   5   src/main.h      (CLIENT_VERSION : PROTOCOL_VERSION in serialize.h is updated only on protocol changes)
   6   share/setup.nsi
   7   doc/README*
   8
   9 * tag version in git
  10
  11    git tag -a v0.5.1
  12
  13 * write release notes.  git shortlog helps a lot:
  14
  15    git shortlog --no-merges v0.5.0..
  16
  17 * perform gitian builds
  18
  19   * From a directory containing the bitcoin source, gitian-builder and gitian.sigs
  20    export SIGNER=(your gitian key, ie bluematt, sipa, etc)
  21    export VERSION=0.5.1
  22    cd ./gitian-builder
  23
  24   * Fetch and build inputs:
  25    mkdir -p inputs; cd inputs/
  26    wget 'http://miniupnp.free.fr/files/download.php?file=miniupnpc-1.6.tar.gz' -O miniupnpc-1.6.tar.gz
  27    wget 'http://www.openssl.org/source/openssl-1.0.0e.tar.gz'
  28    wget 'http://download.oracle.com/berkeley-db/db-4.8.30.NC.tar.gz'
  29    wget 'http://zlib.net/zlib-1.2.6.tar.gz'
  30    wget 'ftp://ftp.simplesystems.org/pub/libpng/png/src/libpng-1.5.9.tar.gz'
  31    wget 'http://fukuchi.org/works/qrencode/qrencode-3.2.0.tar.bz2'
  32    wget 'http://downloads.sourceforge.net/project/boost/boost/1.47.0/boost_1_47_0.tar.bz2'
  33    wget 'http://download.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.7.4.tar.gz'
  34    cd ..
  35    ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/boost-win32.yml
  36    cp build/out/boost-win32-1.47.0-gitian.zip inputs/
  37    ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/qt-win32.yml
  38    cp build/out/qt-win32-4.7.4-gitian.zip inputs/
  39    ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/deps-win32.yml
  40    cp build/out/bitcoin-deps-0.0.1.tbz2 inputs/
  41
  42   * Build bitcoind and bitcoin-qt on Linux32, Linux64, and Win32:
  43    ./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian.yml
  44    ./bin/gsign --signer $SIGNER --release ${VERSION} --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian.yml
  45    pushd build/out
  46    zip -r bitcoin-${VERSION}-linux-gitian.zip *
  47    mv bitcoin-${VERSION}-linux-gitian.zip ../../
  48    popd
  49    ./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-win32.yml
  50    ./bin/gsign --signer $SIGNER --release ${VERSION}-win32 --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-win32.yml
  51    pushd build/out
  52    zip -r bitcoin-${VERSION}-win32-gitian.zip *
  53    mv bitcoin-${VERSION}-win32-gitian.zip ../../
  54    popd
  55
  56   Build output expected:
  57   1. linux 32-bit and 64-bit binaries + source (bitcoin-${VERSION}-linux-gitian.zip)
  58   2. windows 32-bit binary, installer + source (bitcoin-${VERSION}-win32-gitian.zip)
  59   3. Gitian signatures (in gitian.sigs/${VERSION}[-win32]/(your gitian key)/
  60
  61 * repackage gitian builds for release as stand-alone zip/tar/installer exe
  62
  63   * Linux .tar.gz:
  64    unzip bitcoin-${VERSION}-linux-gitian.zip -d bitcoin-${VERSION}-linux
  65    tar czvf bitcoin-${VERSION}-linux.tar.gz bitcoin-${VERSION}-linux
  66    rm -rf bitcoin-${VERSION}-linux
  67
  68   * Windows .zip and setup.exe:
  69    unzip bitcoin-${VERSION}-win32-gitian.zip -d bitcoin-${VERSION}-win32
  70    mv bitcoin-${VERSION}-win32/bitcoin-*-setup.exe .
  71    zip -r bitcoin-${VERSION}-win32.zip bitcoin-${VERSION}-win32
  72    rm -rf bitcoin-${VERSION}-win32
  73
  74 * perform Mac build
  75   See this blog post for how Gavin set up his build environment to build the OSX
  76   release; note that a patched version of macdeployqt is not needed anymore, as
  77   the required functionality and fixes are implemented directly in macdeployqtplus:
  78     http://gavintech.blogspot.com/2011/11/deploying-bitcoin-qt-on-osx.html
  79   qmake USE_SSL=1 USE_UPNP=1 bitcoin-qt.pro
  80   make
  81   export QTDIR=/opt/local/share/qt4  # needed to find translations/qt_*.qm files
  82   T=$(contrib/qt_translations.py $QTDIR/translations src/qt/locale)
  83   contrib/macdeploy/macdeployqtplus Bitcoin-Qt.app -add-qt-tr $T -dmg -fancy contrib/macdeploy/fancy.plist
  84
  85  Build output expected:
  86   Bitcoin-Qt.dmg
  87
  88 * upload builds to SourceForge
  89
  90 * create SHA256SUMS for builds, and PGP-sign it
  91
  92 * update bitcoin.org version
  93
  94 * update forum version
  95
  96 * update wiki download links
  97
  98 * Commit your signature to gitian.sigs:
  99   pushd gitian.sigs
 100   git add ${VERSION}/${SIGNER}
 101   git add ${VERSION}-win32/${SIGNER}
 102   git commit -a
 103   git push  # Assuming you can push to the gitian.sigs tree
 104   popd
 105
 106 -------------------------------------------------------------------------
 107
 108 * After 3 or more people have gitian-built, repackage gitian-signed zips:
 109
 110   * From a directory containing bitcoin source, gitian.sigs and gitian zips
 111    export VERSION=0.5.1
 112    mkdir bitcoin-${VERSION}-linux-gitian
 113    pushd bitcoin-${VERSION}-linux-gitian
 114    unzip ../bitcoin-${VERSION}-linux-gitian.zip
 115    mkdir gitian
 116    cp ../bitcoin/contrib/gitian-downloader/*.pgp ./gitian/
 117    for signer in $(ls ../gitian.sigs/${VERSION}/); do
 118      cp ../gitian.sigs/${VERSION}/${signer}/bitcoin-build.assert ./gitian/${signer}-build.assert
 119      cp ../gitian.sigs/${VERSION}/${signer}/bitcoin-build.assert.sig ./gitian/${signer}-build.assert.sig
 120    done
 121    zip -r bitcoin-${VERSION}-linux-gitian.zip *
 122    cp bitcoin-${VERSION}-linux-gitian.zip ../
 123    popd
 124    mkdir bitcoin-${VERSION}-win32-gitian
 125    pushd bitcoin-${VERSION}-win32-gitian
 126    unzip ../bitcoin-${VERSION}-win32-gitian.zip
 127    mkdir gitian
 128    cp ../bitcoin/contrib/gitian-downloader/*.pgp ./gitian/
 129    for signer in $(ls ../gitian.sigs/${VERSION}-win32/); do
 130      cp ../gitian.sigs/${VERSION}-win32/${signer}/bitcoin-build.assert ./gitian/${signer}-build.assert
 131      cp ../gitian.sigs/${VERSION}-win32/${signer}/bitcoin-build.assert.sig ./gitian/${signer}-build.assert.sig
 132    done
 133    zip -r bitcoin-${VERSION}-win32-gitian.zip *
 134    cp bitcoin-${VERSION}-win32-gitian.zip ../
 135    popd
 136
 137   * Upload gitian zips to SourceForge