aboutsummaryrefslogtreecommitdiff
path: root/doc/release-process.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/release-process.md')
-rw-r--r--doc/release-process.md190
1 files changed, 190 insertions, 0 deletions
diff --git a/doc/release-process.md b/doc/release-process.md
new file mode 100644
index 0000000000..459819e596
--- /dev/null
+++ b/doc/release-process.md
@@ -0,0 +1,190 @@
+Release Process
+====================
+
+* update translations (ping wumpus, Diapolo or tcatm on IRC)
+* see https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#syncing-with-transifex
+
+* * *
+
+###update (commit) version in sources
+
+
+ bitcoin-qt.pro
+ contrib/verifysfbinaries/verify.sh
+ doc/README*
+ share/setup.nsi
+ src/clientversion.h (change CLIENT_VERSION_IS_RELEASE to true)
+
+###tag version in git
+
+ git tag -s v(new version, e.g. 0.8.0)
+
+###write release notes. git shortlog helps a lot, for example:
+
+ git shortlog --no-merges v(current version, e.g. 0.7.2)..v(new version, e.g. 0.8.0)
+
+* * *
+
+##perform gitian builds
+
+ From a directory containing the bitcoin source, gitian-builder and gitian.sigs
+
+ export SIGNER=(your gitian key, ie bluematt, sipa, etc)
+ export VERSION=(new version, e.g. 0.8.0)
+ pushd ./bitcoin
+ git checkout v${VERSION}
+ popd
+ pushd ./gitian-builder
+
+ Fetch and build inputs: (first time, or when dependency versions change)
+
+ mkdir -p inputs; cd inputs/
+ wget 'http://miniupnp.free.fr/files/download.php?file=miniupnpc-1.8.tar.gz' -O miniupnpc-1.8.tar.gz
+ wget 'https://www.openssl.org/source/openssl-1.0.1e.tar.gz'
+ wget 'http://download.oracle.com/berkeley-db/db-4.8.30.NC.tar.gz'
+ wget 'http://zlib.net/zlib-1.2.8.tar.gz'
+ wget 'ftp://ftp.simplesystems.org/pub/png/src/history/libpng16/libpng-1.6.8.tar.gz'
+ wget 'https://fukuchi.org/works/qrencode/qrencode-3.4.3.tar.bz2'
+ wget 'https://downloads.sourceforge.net/project/boost/boost/1.55.0/boost_1_55_0.tar.bz2'
+ wget 'https://svn.boost.org/trac/boost/raw-attachment/ticket/7262/boost-mingw.patch' -O \
+ boost-mingw-gas-cross-compile-2013-03-03.patch
+ wget 'https://download.qt-project.org/official_releases/qt/5.2/5.2.0/single/qt-everywhere-opensource-src-5.2.0.tar.gz'
+ wget 'https://protobuf.googlecode.com/files/protobuf-2.5.0.tar.bz2'
+ cd ..
+ ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/boost-linux.yml
+ mv build/out/boost-*.zip inputs/
+ ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/deps-linux.yml
+ mv build/out/bitcoin-deps-*.zip inputs/
+ ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/boost-win.yml
+ mv build/out/boost-*.zip inputs/
+ ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/deps-win.yml
+ mv build/out/bitcoin-deps-*.zip inputs/
+ ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/qt-win.yml
+ mv build/out/qt-*.zip inputs/
+ ./bin/gbuild ../bitcoin/contrib/gitian-descriptors/protobuf-win.yml
+ mv build/out/protobuf-*.zip inputs/
+
+ Build bitcoind and bitcoin-qt on Linux32, Linux64, and Win32:
+
+ ./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml
+ ./bin/gsign --signer $SIGNER --release ${VERSION} --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml
+ pushd build/out
+ zip -r bitcoin-${VERSION}-linux-gitian.zip *
+ mv bitcoin-${VERSION}-linux-gitian.zip ../../../
+ popd
+ ./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-win.yml
+ ./bin/gsign --signer $SIGNER --release ${VERSION}-win --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-win.yml
+ pushd build/out
+ zip -r bitcoin-${VERSION}-win-gitian.zip *
+ mv bitcoin-${VERSION}-win-gitian.zip ../../../
+ popd
+ popd
+
+ Build output expected:
+
+ 1. linux 32-bit and 64-bit binaries + source (bitcoin-${VERSION}-linux-gitian.zip)
+ 2. windows 32-bit and 64-bit binaries + installer + source (bitcoin-${VERSION}-win-gitian.zip)
+ 3. Gitian signatures (in gitian.sigs/${VERSION}[-win]/(your gitian key)/
+
+repackage gitian builds for release as stand-alone zip/tar/installer exe
+
+**Linux .tar.gz:**
+
+ unzip bitcoin-${VERSION}-linux-gitian.zip -d bitcoin-${VERSION}-linux
+ tar czvf bitcoin-${VERSION}-linux.tar.gz bitcoin-${VERSION}-linux
+ rm -rf bitcoin-${VERSION}-linux
+
+**Windows .zip and setup.exe:**
+
+ unzip bitcoin-${VERSION}-win-gitian.zip -d bitcoin-${VERSION}-win
+ mv bitcoin-${VERSION}-win/bitcoin-*-setup.exe .
+ zip -r bitcoin-${VERSION}-win.zip bitcoin-${VERSION}-win
+ rm -rf bitcoin-${VERSION}-win
+
+**Perform Mac build:**
+
+ OSX binaries are created by Gavin Andresen on a 32-bit, OSX 10.6 machine.
+
+ qmake RELEASE=1 USE_UPNP=1 USE_QRCODE=1 bitcoin-qt.pro
+ make
+ export QTDIR=/opt/local/share/qt4 # needed to find translations/qt_*.qm files
+ T=$(contrib/qt_translations.py $QTDIR/translations src/qt/locale)
+ python2.7 share/qt/clean_mac_info_plist.py
+ python2.7 contrib/macdeploy/macdeployqtplus Bitcoin-Qt.app -add-qt-tr $T -dmg -fancy contrib/macdeploy/fancy.plist
+
+ Build output expected: Bitcoin-Qt.dmg
+
+###Next steps:
+
+* Code-sign Windows -setup.exe (in a Windows virtual machine) and
+ OSX Bitcoin-Qt.app (Note: only Gavin has the code-signing keys currently)
+
+* upload builds to SourceForge
+
+* create SHA256SUMS for builds, and PGP-sign it
+
+* update bitcoin.org version
+ make sure all OS download links go to the right versions
+
+* update download sizes on bitcoin.org/_templates/download.html
+
+* update forum version
+
+* update wiki download links
+
+* update wiki changelog: [https://en.bitcoin.it/wiki/Changelog](https://en.bitcoin.it/wiki/Changelog)
+
+Commit your signature to gitian.sigs:
+
+ pushd gitian.sigs
+ git add ${VERSION}/${SIGNER}
+ git add ${VERSION}-win/${SIGNER}
+ git commit -a
+ git push # Assuming you can push to the gitian.sigs tree
+ popd
+
+-------------------------------------------------------------------------
+
+### After 3 or more people have gitian-built, repackage gitian-signed zips:
+
+From a directory containing bitcoin source, gitian.sigs and gitian zips
+
+ export VERSION=(new version, e.g. 0.8.0)
+ mkdir bitcoin-${VERSION}-linux-gitian
+ pushd bitcoin-${VERSION}-linux-gitian
+ unzip ../bitcoin-${VERSION}-linux-gitian.zip
+ mkdir gitian
+ cp ../bitcoin/contrib/gitian-downloader/*.pgp ./gitian/
+ for signer in $(ls ../gitian.sigs/${VERSION}/); do
+ cp ../gitian.sigs/${VERSION}/${signer}/bitcoin-build.assert ./gitian/${signer}-build.assert
+ cp ../gitian.sigs/${VERSION}/${signer}/bitcoin-build.assert.sig ./gitian/${signer}-build.assert.sig
+ done
+ zip -r bitcoin-${VERSION}-linux-gitian.zip *
+ cp bitcoin-${VERSION}-linux-gitian.zip ../
+ popd
+ mkdir bitcoin-${VERSION}-win-gitian
+ pushd bitcoin-${VERSION}-win-gitian
+ unzip ../bitcoin-${VERSION}-win-gitian.zip
+ mkdir gitian
+ cp ../bitcoin/contrib/gitian-downloader/*.pgp ./gitian/
+ for signer in $(ls ../gitian.sigs/${VERSION}-win/); do
+ cp ../gitian.sigs/${VERSION}-win/${signer}/bitcoin-build.assert ./gitian/${signer}-build.assert
+ cp ../gitian.sigs/${VERSION}-win/${signer}/bitcoin-build.assert.sig ./gitian/${signer}-build.assert.sig
+ done
+ zip -r bitcoin-${VERSION}-win-gitian.zip *
+ cp bitcoin-${VERSION}-win-gitian.zip ../
+ popd
+
+- Upload gitian zips to SourceForge
+
+- Announce the release:
+
+ - Add the release to bitcoin.org: https://github.com/bitcoin/bitcoin.org/tree/master/_releases
+
+ - Release sticky on bitcointalk: https://bitcointalk.org/index.php?board=1.0
+
+ - Bitcoin-development mailing list
+
+ - Optionally reddit /r/Bitcoin, ...
+
+- Celebrate