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