Merge branch '0.4.x' into 0.5.x
[novacoin.git] / 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/serialize.h
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.1b.tar.gz'
28    wget 'http://download.oracle.com/berkeley-db/db-4.8.30.NC.tar.gz'
29    wget 'http://downloads.sourceforge.net/project/boost/boost/1.47.0/boost_1_47_0.tar.bz2'
30    wget 'http://download.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.7.4.tar.gz'
31    cd ..
32    ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/boost-win32.yml
33    cp build/out/boost-win32-1.47.0-gitian.zip inputs/
34    ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/qt-win32.yml
35    cp build/out/qt-win32-4.7.4-gitian.zip inputs/
36
37   * Build bitcoind and bitcoin-qt on Linux32, Linux64, and Win32:
38    ./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian.yml
39    ./bin/gsign --signer $SIGNER --release ${VERSION} --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian.yml
40    pushd build/out
41    zip -r bitcoin-${VERSION}-linux-gitian.zip *
42    mv bitcoin-${VERSION}-linux-gitian.zip ../../
43    popd
44    ./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-win32.yml
45    ./bin/gsign --signer $SIGNER --release ${VERSION}-win32 --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-win32.yml
46    pushd build/out
47    zip -r bitcoin-${VERSION}-win32-gitian.zip *
48    mv bitcoin-${VERSION}-win32-gitian.zip ../../
49    popd
50
51   Build output expected:
52   1. linux 32-bit and 64-bit binaries + source (bitcoin-${VERSION}-linux-gitian.zip)
53   2. windows 32-bit binary, installer + source (bitcoin-${VERSION}-win32-gitian.zip)
54   3. Gitian signatures (in gitian.sigs/${VERSION}[-win32]/(your gitian key)/
55
56 * repackage gitian builds for release as stand-alone zip/tar/installer exe
57
58   * Linux .tar.gz:
59    unzip bitcoin-${VERSION}-linux-gitian.zip -d bitcoin-${VERSION}-linux
60    tar czvf bitcoin-${VERSION}-linux.tar.gz bitcoin-${VERSION}-linux
61    rm -rf bitcoin-${VERSION}-linux
62
63   * Windows .zip and setup.exe:
64    unzip bitcoin-${VERSION}-win32-gitian.zip -d bitcoin-${VERSION}-win32
65    mv bitcoin-${VERSION}-win32/bitcoin-*-setup.exe .
66    zip -r bitcoin-${VERSION}-win32.zip bitcoin-${VERSION}-win32
67    rm -rf bitcoin-${VERSION}-win32
68
69 * perform Mac build
70   See this blog post for how Gavin set up his build environment and
71   patched macdeployqt to build the OSX release:
72     http://gavintech.blogspot.com/2011/11/deploying-bitcoin-qt-on-osx.html
73   qmake USE_SSL=1 USE_UPNP=1 bitcoin-qt.pro
74   make
75   export QTDIR=/opt/local/share/qt4  # needed to find translations/qt_*.qm files
76   T=$(contrib/qt_translations.py $QTDIR/translations src/qt/locale)
77   contrib/macdeploy/macdeployqtplus Bitcoin-Qt.app -add-qt-tr $T -dmg -fancy contrib/macdeploy/fancy.plist  
78
79  Build output expected:
80   Bitcoin-Qt.dmg
81
82 * upload builds to SourceForge
83
84 * create SHA256SUMS for builds, and PGP-sign it
85
86 * update bitcoin.org version
87
88 * update forum version
89
90 * update wiki download links
91
92 * update wiki changelog: https://en.bitcoin.it/wiki/Changelog
93
94 * Commit your signature to gitian.sigs:
95   pushd gitian.sigs
96   git add ${VERSION}/${SIGNER}
97   git add ${VERSION}-win32/${SIGNER}
98   git commit -a
99   git push  # Assuming you can push to the gitian.sigs tree
100   popd
101
102 -------------------------------------------------------------------------
103
104 * After 3 or more people have gitian-built, repackage gitian-signed zips:
105
106   * From a directory containing bitcoin source, gitian.sigs and gitian zips
107    export VERSION=0.5.1
108    mkdir bitcoin-${VERSION}-linux-gitian
109    pushd bitcoin-${VERSION}-linux-gitian
110    unzip ../bitcoin-${VERSION}-linux-gitian.zip
111    mkdir gitian
112    cp ../bitcoin/contrib/gitian-downloader/*.pgp ./gitian/
113    for signer in $(ls ../gitian.sigs/${VERSION}/); do
114      cp ../gitian.sigs/${VERSION}/${signer}/bitcoin-build.assert ./gitian/${signer}-build.assert
115      cp ../gitian.sigs/${VERSION}/${signer}/bitcoin-build.assert.sig ./gitian/${signer}-build.assert.sig
116    done
117    zip -r bitcoin-${VERSION}-linux-gitian.zip *
118    cp bitcoin-${VERSION}-linux-gitian.zip ../
119    popd
120    mkdir bitcoin-${VERSION}-win32-gitian
121    pushd bitcoin-${VERSION}-win32-gitian
122    unzip ../bitcoin-${VERSION}-win32-gitian.zip
123    mkdir gitian
124    cp ../bitcoin/contrib/gitian-downloader/*.pgp ./gitian/
125    for signer in $(ls ../gitian.sigs/${VERSION}-win32/); do
126      cp ../gitian.sigs/${VERSION}-win32/${signer}/bitcoin-build.assert ./gitian/${signer}-build.assert
127      cp ../gitian.sigs/${VERSION}-win32/${signer}/bitcoin-build.assert.sig ./gitian/${signer}-build.assert.sig
128    done
129    zip -r bitcoin-${VERSION}-win32-gitian.zip *
130    cp bitcoin-${VERSION}-win32-gitian.zip ../
131    popd
132
133   * Upload gitian zips to SourceForge