mirror of
https://github.com/dashpay/dash.git
synced 2024-12-26 12:32:48 +01:00
1188dd28ac
faead5e [doc] release-process: Mention GitHub release and archived release notes (MarcoFalke)
205 lines
8.2 KiB
Markdown
205 lines
8.2 KiB
Markdown
Release Process
|
|
====================
|
|
|
|
* Update translations, see [translation_process.md](https://github.com/dashpay/dash/blob/master/doc/translation_process.md#synchronising-translations).
|
|
* Update hardcoded [seeds](/contrib/seeds)
|
|
|
|
* * *
|
|
|
|
### First time / New builders
|
|
If you're using the automated script (found in [contrib/gitian-build.sh](/contrib/gitian-build.sh)), then at this point you should run it with the "--setup" command. Otherwise ignore this.
|
|
|
|
Check out the source code in the following directory hierarchy.
|
|
|
|
cd /path/to/your/toplevel/build
|
|
git clone https://github.com/dashpay/gitian.sigs.git
|
|
git clone https://github.com/dashpay/dash-detached-sigs.git
|
|
git clone https://github.com/devrandom/gitian-builder.git
|
|
git clone https://github.com/dashpay/dash.git
|
|
|
|
### Dash Core maintainers/release engineers, update (commit) version in sources
|
|
|
|
pushd ./dash
|
|
contrib/verifysfbinaries/verify.sh
|
|
configure.ac
|
|
doc/README*
|
|
doc/Doxyfile
|
|
contrib/gitian-descriptors/*.yml
|
|
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)
|
|
popd
|
|
|
|
* * *
|
|
|
|
### Setup and perform Gitian builds
|
|
|
|
If you're using the automated script (found in [contrib/gitian-build.sh](/contrib/gitian-build.sh)), then at this point you should run it with the "--build" command. Otherwise ignore this.
|
|
|
|
Setup Gitian descriptors:
|
|
|
|
pushd ./dash
|
|
export SIGNER=(your Gitian key, ie bluematt, sipa, etc)
|
|
export VERSION=(new version, e.g. 0.8.0)
|
|
git fetch
|
|
git checkout v${VERSION}
|
|
popd
|
|
|
|
Ensure your gitian.sigs are up-to-date if you wish to gverify your builds against other Gitian signatures.
|
|
|
|
pushd ./gitian.sigs
|
|
git pull
|
|
popd
|
|
|
|
Ensure gitian-builder is up-to-date:
|
|
|
|
pushd ./gitian-builder
|
|
git pull
|
|
|
|
### Fetch and create inputs: (first time, or when dependency versions change)
|
|
|
|
mkdir -p inputs
|
|
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
|
|
|
|
Create the OS X SDK tarball, see the [OS X readme](README_osx.md) for details, and copy it into the inputs directory.
|
|
|
|
### Optional: Seed the Gitian sources cache and offline git repositories
|
|
|
|
By default, Gitian will fetch source files as needed. To cache them ahead of time:
|
|
|
|
make -C ../dash/depends download SOURCES_PATH=`pwd`/cache/common
|
|
|
|
Only missing files will be fetched, so this is safe to re-run for each build.
|
|
|
|
NOTE: Offline builds must use the --url flag to ensure Gitian fetches only from local URLs. For example:
|
|
```
|
|
./bin/gbuild --url dash=/path/to/dash,signature=/path/to/sigs {rest of arguments}
|
|
```
|
|
The gbuild invocations below <b>DO NOT DO THIS</b> by default.
|
|
|
|
### Build and sign Dash Core for Linux, Windows, and OS X:
|
|
|
|
./bin/gbuild --memory 3000 --commit dash=v${VERSION} ../dash/contrib/gitian-descriptors/gitian-linux.yml
|
|
./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 ../
|
|
|
|
./bin/gbuild --memory 3000 --commit dash=v${VERSION} ../dash/contrib/gitian-descriptors/gitian-win.yml
|
|
./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
|
|
mv build/out/dash-*.zip build/out/dash-*.exe ../
|
|
|
|
./bin/gbuild --memory 3000 --commit dash=v${VERSION} ../dash/contrib/gitian-descriptors/gitian-osx.yml
|
|
./bin/gsign --signer $SIGNER --release ${VERSION}-osx-unsigned --destination ../gitian.sigs/ ../dash/contrib/gitian-descriptors/gitian-osx.yml
|
|
mv build/out/dash-*-osx-unsigned.tar.gz inputs/dash-osx-unsigned.tar.gz
|
|
mv build/out/dash-*.tar.gz build/out/dash-*.dmg ../
|
|
popd
|
|
|
|
Build output expected:
|
|
|
|
1. source tarball (dash-${VERSION}.tar.gz)
|
|
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)
|
|
5. Gitian signatures (in gitian.sigs/${VERSION}-<linux|{win,osx}-unsigned>/(your Gitian key)/
|
|
|
|
### Verify other gitian builders signatures to your own. (Optional)
|
|
|
|
Add other gitian builders keys to your gpg keyring, and/or refresh keys.
|
|
|
|
gpg --import ../dash/contrib/gitian-keys/*.pgp
|
|
gpg --refresh-keys
|
|
|
|
Verify the signatures
|
|
|
|
./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
|
|
|
|
popd
|
|
|
|
### Next steps:
|
|
|
|
Commit your signature to gitian.sigs:
|
|
|
|
pushd gitian.sigs
|
|
git add ${VERSION}-linux/${SIGNER}
|
|
git add ${VERSION}-win-unsigned/${SIGNER}
|
|
git add ${VERSION}-osx-unsigned/${SIGNER}
|
|
git commit -a
|
|
git push # Assuming you can push to the gitian.sigs tree
|
|
popd
|
|
|
|
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.
|
|
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.
|
|
|
|
Create (and optionally verify) the signed OS X binary:
|
|
|
|
pushd ./gitian-builder
|
|
./bin/gbuild -i --commit signature=v${VERSION} ../dash/contrib/gitian-descriptors/gitian-osx-signer.yml
|
|
./bin/gsign --signer $SIGNER --release ${VERSION}-osx-signed --destination ../gitian.sigs/ ../dash/contrib/gitian-descriptors/gitian-osx-signer.yml
|
|
./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-osx-signed ../dash/contrib/gitian-descriptors/gitian-osx-signer.yml
|
|
mv build/out/dash-osx-signed.dmg ../dash-${VERSION}-osx.dmg
|
|
popd
|
|
|
|
Create (and optionally verify) the signed Windows binaries:
|
|
|
|
pushd ./gitian-builder
|
|
./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
|
|
popd
|
|
|
|
Commit your signature for the signed OS X/Windows binaries:
|
|
|
|
pushd gitian.sigs
|
|
git add ${VERSION}-osx-signed/${SIGNER}
|
|
git add ${VERSION}-win-signed/${SIGNER}
|
|
git commit -a
|
|
git push # Assuming you can push to the gitian.sigs tree
|
|
popd
|
|
|
|
-------------------------------------------------------------------------
|
|
|
|
### After 3 or more people have gitian-built and their results match:
|
|
|
|
- Create `SHA256SUMS.asc` for the builds, and GPG-sign it:
|
|
```bash
|
|
sha256sum * > SHA256SUMS
|
|
gpg --digest-algo sha256 --clearsign SHA256SUMS # outputs SHA256SUMS.asc
|
|
rm SHA256SUMS
|
|
```
|
|
(the digest algorithm is forced to sha256 to avoid confusion of the `Hash:` header that GPG adds with the SHA256 used for the files)
|
|
Note: check that SHA256SUMS itself doesn't end up in SHA256SUMS, which is a spurious/nonsensical entry.
|
|
|
|
- Upload zips and installers, as well as `SHA256SUMS.asc` from last step, to the dash.org server
|
|
|
|
- Update dash.org
|
|
|
|
- Announce the release:
|
|
|
|
- Release on Dash forum: https://www.dash.org/forum/topic/official-announcements.54/
|
|
|
|
- Dash-development mailing list
|
|
|
|
- Update title of #dashpay on Freenode IRC
|
|
|
|
- Optionally reddit /r/Dashpay, ... but this will usually sort out itself
|
|
|
|
- Notify flare so that he can start building [the PPAs](https://launchpad.net/~dash.org/+archive/ubuntu/dash)
|
|
|
|
- Archive release notes for the new version to `doc/release-notes/` (branch `master` and branch of the release)
|
|
|
|
- Create a [new GitHub release](https://github.com/dashpay/dash/releases/new) with a link to the archived release notes.
|
|
|
|
- Celebrate
|