2013-05-20 06:30:00 +02:00
Release Process
====================
2017-12-28 15:52:20 +01:00
* Update translations, see [translation_process.md ](https://github.com/dashpay/dash/blob/master/doc/translation_process.md#synchronising-translations ).
2015-12-25 13:09:26 +01:00
* Update hardcoded [seeds ](/contrib/seeds )
2013-05-20 06:30:00 +02:00
* * *
2017-05-05 13:28:08 +02:00
### First time / New builders
2015-10-13 13:11:17 +02:00
Check out the source code in the following directory hierarchy.
2013-05-20 06:30:00 +02:00
2015-09-17 23:17:26 +02:00
cd /path/to/your/toplevel/build
2016-02-02 16:28:56 +01:00
git clone https://github.com/dashpay/gitian.sigs.git
git clone https://github.com/dashpay/dash-detached-sigs.git
2015-09-17 23:17:26 +02:00
git clone https://github.com/devrandom/gitian-builder.git
2016-02-02 16:28:56 +01:00
git clone https://github.com/dashpay/dash.git
2015-09-17 23:17:26 +02:00
2017-05-05 13:28:08 +02:00
### Dash Core maintainers/release engineers, update (commit) version in sources
2015-09-17 23:17:26 +02:00
2016-02-02 16:28:56 +01:00
pushd ./dash
2013-05-20 06:30:00 +02:00
contrib/verifysfbinaries/verify.sh
2015-12-25 13:09:26 +01:00
configure.ac
2013-05-20 06:30:00 +02:00
doc/README*
2015-12-25 13:09:26 +01:00
doc/Doxyfile
contrib/gitian-descriptors/*.yml
2013-05-20 06:30:00 +02:00
src/clientversion.h (change CLIENT_VERSION_IS_RELEASE to true)
2015-10-13 13:11:17 +02:00
# tag version in git
2013-05-20 06:30:00 +02:00
2013-12-06 01:26:40 +01:00
git tag -s v(new version, e.g. 0.8.0)
2013-05-20 06:30:00 +02:00
2015-10-13 13:11:17 +02:00
# write release notes. git shortlog helps a lot, for example:
2013-05-20 06:30:00 +02:00
2013-05-25 22:29:28 +02:00
git shortlog --no-merges v(current version, e.g. 0.7.2)..v(new version, e.g. 0.8.0)
2015-09-17 23:17:26 +02:00
popd
2013-05-20 06:30:00 +02:00
* * *
2017-05-05 13:28:08 +02:00
### Setup and perform Gitian builds
2014-08-13 01:24:05 +02:00
2015-10-17 12:10:45 +02:00
Setup Gitian descriptors:
2014-08-13 01:24:05 +02:00
2016-02-02 16:28:56 +01:00
pushd ./dash
2015-10-17 12:10:45 +02:00
export SIGNER=(your Gitian key, ie bluematt, sipa, etc)
2013-05-25 22:29:28 +02:00
export VERSION=(new version, e.g. 0.8.0)
2015-12-25 13:09:26 +01:00
git fetch
2013-09-24 21:31:52 +02:00
git checkout v${VERSION}
popd
2015-09-17 23:17:26 +02:00
2015-10-17 12:10:45 +02:00
Ensure your gitian.sigs are up-to-date if you wish to gverify your builds against other Gitian signatures.
2015-09-17 23:17:26 +02:00
pushd ./gitian.sigs
git pull
popd
2016-06-21 16:32:20 +02:00
Ensure gitian-builder is up-to-date:
2015-09-17 23:17:26 +02:00
2013-07-07 18:24:15 +02:00
pushd ./gitian-builder
2015-09-17 23:17:26 +02:00
git pull
2014-05-14 01:23:22 +02:00
2017-05-05 13:28:08 +02:00
### Fetch and create inputs: (first time, or when dependency versions change)
2014-05-14 01:23:22 +02:00
2014-12-11 21:38:29 +01:00
mkdir -p inputs
2015-06-19 00:17:36 +02:00
wget -P inputs https://bitcoincore.org/cfields/osslsigncode-Backports-to-1.7.1.patch
wget -P inputs http://downloads.sourceforge.net/project/osslsigncode/osslsigncode/osslsigncode-1.7.1.tar.gz
2013-05-20 06:30:00 +02:00
2016-06-21 16:32:20 +02:00
Create the OS X SDK tarball, see the [OS X readme ](README_osx.md ) for details, and copy it into the inputs directory.
2014-12-11 21:38:29 +01:00
2017-05-05 13:28:08 +02:00
### Optional: Seed the Gitian sources cache and offline git repositories
2014-12-12 00:53:24 +01:00
2015-10-17 12:10:45 +02:00
By default, Gitian will fetch source files as needed. To cache them ahead of time:
2014-12-11 21:38:29 +01:00
2015-04-03 00:51:08 +02:00
make -C ../dash/depends download SOURCES_PATH=`pwd`/cache/common
2014-12-11 21:38:29 +01:00
2015-09-17 23:17:26 +02:00
Only missing files will be fetched, so this is safe to re-run for each build.
2015-10-17 12:10:45 +02:00
NOTE: Offline builds must use the --url flag to ensure Gitian fetches only from local URLs. For example:
2015-10-13 13:11:17 +02:00
```
2016-02-28 10:58:28 +01:00
./bin/gbuild --url dash=/path/to/dash,signature=/path/to/sigs {rest of arguments}
2015-10-13 13:11:17 +02:00
```
The gbuild invocations below < b > DO NOT DO THIS< / b > by default.
2014-12-11 21:38:29 +01:00
2017-05-05 13:28:08 +02:00
### Build and sign Dash Core for Linux, Windows, and OS X:
2015-01-13 18:58:24 +01:00
2015-03-19 15:15:08 +01:00
./bin/gbuild --commit dash=v${VERSION} ../dash/contrib/gitian-descriptors/gitian-linux.yml
2015-04-03 00:51:08 +02:00
./bin/gsign --signer $SIGNER --release ${VERSION}-linux --destination ../gitian.sigs/ ../dash/contrib/gitian-descriptors/gitian-linux.yml
mv build/out/dash-*.tar.gz build/out/src/dash-*.tar.gz ../
2015-09-17 23:17:26 +02:00
2016-02-28 10:58:28 +01:00
./bin/gbuild --commit dash=v${VERSION} ../dash/contrib/gitian-descriptors/gitian-win.yml
2016-02-02 16:28:56 +01:00
./bin/gsign --signer $SIGNER --release ${VERSION}-win-unsigned --destination ../gitian.sigs/ ../dash/contrib/gitian-descriptors/gitian-win.yml
mv build/out/dash-*-win-unsigned.tar.gz inputs/dash-win-unsigned.tar.gz
2015-04-03 00:51:08 +02:00
mv build/out/dash-*.zip build/out/dash-*.exe ../
2015-09-17 23:17:26 +02:00
2016-02-28 10:58:28 +01:00
./bin/gbuild --commit dash=v${VERSION} ../dash/contrib/gitian-descriptors/gitian-osx.yml
2015-04-03 00:51:08 +02:00
./bin/gsign --signer $SIGNER --release ${VERSION}-osx-unsigned --destination ../gitian.sigs/ ../dash/contrib/gitian-descriptors/gitian-osx.yml
2016-02-02 16:28:56 +01:00
mv build/out/dash-*-osx-unsigned.tar.gz inputs/dash-osx-unsigned.tar.gz
2015-04-03 00:51:08 +02:00
mv build/out/dash-*.tar.gz build/out/dash-*.dmg ../
2014-05-14 01:23:22 +02:00
popd
2015-09-17 23:17:26 +02:00
2013-05-20 06:30:00 +02:00
Build output expected:
2015-04-03 00:51:08 +02:00
1. source tarball (dash-${VERSION}.tar.gz)
2016-02-02 16:28:56 +01:00
2. linux 32-bit and 64-bit dist tarballs (dash-${VERSION}-linux[32|64].tar.gz)
3. windows 32-bit and 64-bit unsigned installers and dist zips (dash-${VERSION}-win[32|64]-setup-unsigned.exe, dash-${VERSION}-win[32|64].zip)
4. OS X unsigned installer and dist tarball (dash-${VERSION}-osx-unsigned.dmg, dash-${VERSION}-osx64.tar.gz)
2015-10-17 12:10:45 +02:00
5. Gitian signatures (in gitian.sigs/${VERSION}-< linux |{ win , osx } -unsigned > /(your Gitian key)/
2013-05-20 06:30:00 +02:00
2017-05-05 13:28:08 +02:00
### Verify other gitian builders signatures to your own. (Optional)
2015-12-25 13:09:26 +01:00
Add other gitian builders keys to your gpg keyring
2016-04-15 13:15:55 +02:00
gpg --import ../dash/contrib/gitian-keys/*.pgp
2015-12-25 13:09:26 +01:00
Verify the signatures
2016-02-21 02:09:11 +01:00
./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-linux ../dash/contrib/gitian-descriptors/gitian-linux.yml
./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-win-unsigned ../dash/contrib/gitian-descriptors/gitian-win.yml
./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-osx-unsigned ../dash/contrib/gitian-descriptors/gitian-osx.yml
2015-12-25 13:09:26 +01:00
popd
2017-05-05 13:28:08 +02:00
### Next steps:
2013-05-20 06:30:00 +02:00
Commit your signature to gitian.sigs:
pushd gitian.sigs
2014-07-01 18:29:44 +02:00
git add ${VERSION}-linux/${SIGNER}
2015-06-26 14:48:41 +02:00
git add ${VERSION}-win-unsigned/${SIGNER}
2014-11-26 01:23:18 +01:00
git add ${VERSION}-osx-unsigned/${SIGNER}
git commit -a
git push # Assuming you can push to the gitian.sigs tree
popd
2013-05-20 06:30:00 +02:00
2015-10-17 12:10:45 +02:00
Wait for Windows/OS X detached signatures:
Once the Windows/OS X builds each have 3 matching signatures, they will be signed with their respective release keys.
2016-02-02 16:28:56 +01:00
Detached signatures will then be committed to the [dash-detached-sigs ](https://github.com/dashpay/dash-detached-sigs ) repository, which can be combined with the unsigned apps to create signed binaries.
2014-09-27 20:47:12 +02:00
2015-10-17 12:10:45 +02:00
Create (and optionally verify) the signed OS X binary:
2014-09-27 20:47:12 +02:00
2014-11-26 01:23:18 +01:00
pushd ./gitian-builder
2016-02-02 16:28:56 +01:00
./bin/gbuild -i --commit signature=v${VERSION} ../dash/contrib/gitian-descriptors/gitian-osx-signer.yml
2015-04-03 00:51:08 +02:00
./bin/gsign --signer $SIGNER --release ${VERSION}-osx-signed --destination ../gitian.sigs/ ../dash/contrib/gitian-descriptors/gitian-osx-signer.yml
2016-02-02 16:28:56 +01:00
./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-osx-signed ../dash/contrib/gitian-descriptors/gitian-osx-signer.yml
2015-04-03 00:51:08 +02:00
mv build/out/dash-osx-signed.dmg ../dash-${VERSION}-osx.dmg
2014-11-26 01:23:18 +01:00
popd
2013-05-20 06:30:00 +02:00
2015-09-17 23:17:26 +02:00
Create (and optionally verify) the signed Windows binaries:
2015-06-19 00:17:36 +02:00
pushd ./gitian-builder
2016-02-02 16:28:56 +01:00
./bin/gbuild -i --commit signature=v${VERSION} ../dash/contrib/gitian-descriptors/gitian-win-signer.yml
./bin/gsign --signer $SIGNER --release ${VERSION}-win-signed --destination ../gitian.sigs/ ../dash/contrib/gitian-descriptors/gitian-win-signer.yml
./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-win-signed ../dash/contrib/gitian-descriptors/gitian-win-signer.yml
mv build/out/dash-*win64-setup.exe ../dash-${VERSION}-win64-setup.exe
mv build/out/dash-*win32-setup.exe ../dash-${VERSION}-win32-setup.exe
2015-06-19 00:17:36 +02:00
popd
2015-10-17 12:10:45 +02:00
Commit your signature for the signed OS X/Windows binaries:
2013-05-20 06:30:00 +02:00
pushd gitian.sigs
2014-11-26 01:23:18 +01:00
git add ${VERSION}-osx-signed/${SIGNER}
2015-06-19 00:17:36 +02:00
git add ${VERSION}-win-signed/${SIGNER}
2013-05-20 06:30:00 +02:00
git commit -a
git push # Assuming you can push to the gitian.sigs tree
popd
-------------------------------------------------------------------------
2014-08-22 11:28:51 +02:00
### After 3 or more people have gitian-built and their results match:
2013-05-20 06:30:00 +02:00
2014-09-27 15:58:47 +02:00
- Create `SHA256SUMS.asc` for the builds, and GPG-sign it:
```bash
sha256sum * > SHA256SUMS
2014-09-29 16:58:30 +02:00
gpg --digest-algo sha256 --clearsign SHA256SUMS # outputs SHA256SUMS.asc
2014-09-27 15:58:47 +02:00
rm SHA256SUMS
2014-08-22 11:28:51 +02:00
```
2014-09-29 16:58:30 +02:00
(the digest algorithm is forced to sha256 to avoid confusion of the `Hash:` header that GPG adds with the SHA256 used for the files)
2015-02-16 10:37:13 +01:00
Note: check that SHA256SUMS itself doesn't end up in SHA256SUMS, which is a spurious/nonsensical entry.
2014-08-22 11:28:51 +02:00
2016-01-31 14:11:16 +01:00
- Upload zips and installers, as well as `SHA256SUMS.asc` from last step, to the dash.org server
2014-08-04 09:47:59 +02:00
2016-01-31 14:11:16 +01:00
- Update dash.org
2014-08-22 11:28:51 +02:00
- Announce the release:
2013-12-10 09:57:30 +01:00
2016-10-22 18:52:14 +02:00
- Release on Dash forum: https://www.dash.org/forum/topic/official-announcements.54/
2013-12-10 09:57:30 +01:00
2015-04-03 00:51:08 +02:00
- Dash-development mailing list
2013-12-10 09:57:30 +01:00
2015-04-03 00:51:08 +02:00
- Update title of #dashpay on Freenode IRC
2014-08-22 11:28:51 +02:00
2015-04-03 00:51:08 +02:00
- Optionally reddit /r/Dashpay, ... but this will usually sort out itself
2014-08-22 11:28:51 +02:00
2016-07-04 07:42:50 +02:00
- Notify flare so that he can start building [the PPAs ](https://launchpad.net/~dash.org/+archive/ubuntu/dash )
2014-08-22 11:28:51 +02:00
- Add release notes for the new version to the directory `doc/release-notes` in git master
2013-12-10 09:57:30 +01:00
2015-01-13 18:58:24 +01:00
- Celebrate