Skip to content

Latest commit

 

History

History
290 lines (202 loc) · 12.1 KB

release-process.md

File metadata and controls

290 lines (202 loc) · 12.1 KB
Raw

Release Process

Branch updates

Before every release candidate

Before every major and minor release

  • Update version in configure.ac (don't forget to set CLIENT_VERSION_IS_RELEASE to true) (don't forget to set CLIENT_VERSION_RC to 0)
  • Write release notes (see below)

Before every major release

  • Update hardcoded seeds, see this pull request for an example.
  • Update BLOCK_CHAIN_SIZE to the current size plus some overhead.
  • Update src/chainparams.cpp with statistics about the transaction count and rate.
  • On both the master branch and the new release branch:
  • On the new release branch in configure.ac:
    • set CLIENT_VERSION_REVISION to 0
    • set CLIENT_VERSION_IS_RELEASE to true

After branch-off (on master)

  • Update the version of contrib/gitian-descriptors/*.yml.

After branch-off (on the major release branch)

  • Update the versions and the link to the release notes draft in doc/release-notes.md.

Before final release

  • Merge the release notes into the branch.
  • Ensure the "Needs release note" label is removed from all relevant pull requests and issues.

Building

First time / New builders

If you're using the automated script (found in contrib/gitian-build.py), 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/martexcoin/gitian.sigs.git
git clone https://github.com/martexcoin/martex-detached-sigs.git
git clone https://github.com/devrandom/gitian-builder.git
git clone https://github.com/martexcoin/martexcoin.git

MarteX maintainers/release engineers, suggestion for writing release notes

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)

Generate list of authors:

git log --format='- %aN' v(current version, e.g. 3.2.2)..v(new version, e.g. 3.2.3) | sort -fiu

Tag the version (or release candidate) in git:

git tag -s v(new version, e.g. 0.8.0)

Setup and perform Gitian builds

If you're using the automated script (found in contrib/gitian-build.py), then at this point you should run it with the "--build" command. Otherwise ignore this.

Setup Gitian descriptors:

pushd ./martex
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
popd

Fetch and create inputs: (first time, or when dependency versions change)

pushd ./gitian-builder
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
popd

Create the macOS SDK tarball, see the macOS build instructions for details, and copy it into the inputs directory.

Optional: Seed the Gitian sources cache and offline git repositories

NOTE: Gitian is sometimes unable to download files. If you have errors, try the step below.

By default, Gitian will fetch source files as needed. To cache them ahead of time, make sure you have checked out the tag you want to build in martex, then:

pushd ./gitian-builder
make -C ../martexcoin/depends download SOURCES_PATH=`pwd`/cache/common
popd

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:

pushd ./gitian-builder
./bin/gbuild --url martex=/path/to/martexcoin,signature=/path/to/sigs {rest of arguments}
popd

The gbuild invocations below DO NOT DO THIS by default.

Build and sign MarteX Core for Linux, Windows, and macOS:

pushd ./gitian-builder
./bin/gbuild --num-make 2 --memory 3000 --commit martex=v${VERSION} ../martexcoin/contrib/gitian-descriptors/gitian-linux.yml
./bin/gsign --signer "$SIGNER" --release ${VERSION}-linux --destination ../gitian.sigs/ ../martexcoin/contrib/gitian-descriptors/gitian-linux.yml
mv build/out/martex-*.tar.gz build/out/src/martex-*.tar.gz ../

./bin/gbuild --num-make 2 --memory 3000 --commit martex=v${VERSION} ../martexcoin/contrib/gitian-descriptors/gitian-win.yml
./bin/gsign --signer "$SIGNER" --release ${VERSION}-win-unsigned --destination ../gitian.sigs/ ../martexcoin/contrib/gitian-descriptors/gitian-win.yml
mv build/out/martex-*-win-unsigned.tar.gz inputs/martex-win-unsigned.tar.gz
mv build/out/martex-*.zip build/out/martex-*.exe ../

./bin/gbuild --num-make 2 --memory 3000 --commit martex=v${VERSION} ../martexcoin/contrib/gitian-descriptors/gitian-osx.yml
./bin/gsign --signer "$SIGNER" --release ${VERSION}-osx-unsigned --destination ../gitian.sigs/ ../martexcoin/contrib/gitian-descriptors/gitian-osx.yml
mv build/out/martex-*-osx-unsigned.tar.gz inputs/martex-osx-unsigned.tar.gz
mv build/out/martex-*.tar.gz build/out/martex-*.dmg ../
popd

Build output expected:

  1. source tarball (martex-${VERSION}.tar.gz)
  2. linux 32-bit and 64-bit dist tarballs (martex-${VERSION}-linux[32|64].tar.gz)
  3. windows 32-bit and 64-bit unsigned installers and dist zips (martex-${VERSION}-win[32|64]-setup-unsigned.exe, martex-${VERSION}-win[32|64].zip)
  4. macOS unsigned installer and dist tarball (martex-${VERSION}-osx-unsigned.dmg, martex-${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 martexcoin/contrib/gitian-keys/*.pgp
gpg --refresh-keys

Verify the signatures

pushd ./gitian-builder
./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-linux ../martexcoin/contrib/gitian-descriptors/gitian-linux.yml
./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-win-unsigned ../martexcoin/contrib/gitian-descriptors/gitian-win.yml
./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-osx-unsigned ../martexcoin/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 -m "Add ${VERSION} unsigned sigs for ${SIGNER}"
git push  # Assuming you can push to the gitian.sigs tree
popd

Codesigner only: Create Windows/macOS detached signatures:

  • Only one person handles codesigning. Everyone else should skip to the next step.
  • Only once the Windows/macOS builds each have 3 matching signatures may they be signed with their respective release keys.

Codesigner only: Sign the macOS binary:

transfer martex-osx-unsigned.tar.gz to macOS for signing
tar xf martex-osx-unsigned.tar.gz
./detached-sig-create.sh -s "Key ID"
Enter the keychain password and authorize the signature
Move signature-osx.tar.gz back to the gitian host

Codesigner only: Sign the windows binaries:

tar xf martex-win-unsigned.tar.gz
./detached-sig-create.sh -key /path/to/codesign.key
Enter the passphrase for the key when prompted
signature-win.tar.gz will be created

Codesigner only: Commit the detached codesign payloads:

cd ~/martex-detached-sigs
checkout the appropriate branch for this release series
rm -rf *
tar xf signature-osx.tar.gz
tar xf signature-win.tar.gz
git add -a
git commit -m "point to ${VERSION}"
git tag -s v${VERSION} HEAD
git push the current branch and new tag

Non-codesigners: wait for Windows/macOS detached signatures:

  • Once the Windows/macOS builds each have 3 matching signatures, they will be signed with their respective release keys.
  • Detached signatures will then be committed to the martex-detached-sigs repository, which can be combined with the unsigned apps to create signed binaries.

Create (and optionally verify) the signed macOS binary:

pushd ./gitian-builder
./bin/gbuild -i --commit signature=v${VERSION} ../martexcoin/contrib/gitian-descriptors/gitian-osx-signer.yml
./bin/gsign --signer "$SIGNER" --release ${VERSION}-osx-signed --destination ../gitian.sigs/ ../martexcoin/contrib/gitian-descriptors/gitian-osx-signer.yml
./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-osx-signed ../martexcoin/contrib/gitian-descriptors/gitian-osx-signer.yml
mv build/out/martex-osx-signed.dmg ../martex-${VERSION}-osx.dmg
popd

Create (and optionally verify) the signed Windows binaries:

pushd ./gitian-builder
./bin/gbuild -i --commit signature=v${VERSION} ../martexcoin/contrib/gitian-descriptors/gitian-win-signer.yml
./bin/gsign --signer "$SIGNER" --release ${VERSION}-win-signed --destination ../gitian.sigs/ ../martexcoin/contrib/gitian-descriptors/gitian-win-signer.yml
./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-win-signed ../martexcoin/contrib/gitian-descriptors/gitian-win-signer.yml
mv build/out/martex-*win64-setup.exe ../martex-${VERSION}-win64-setup.exe
popd

Commit your signature for the signed macOS/Windows binaries:

pushd gitian.sigs
git add ${VERSION}-osx-signed/"${SIGNER}"
git add ${VERSION}-win-signed/"${SIGNER}"
git commit -m "Add ${SIGNER} ${VERSION} signed binaries signatures"
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:
sha256sum * > SHA256SUMS

The list of files should be:

martex-${VERSION}-aarch64-linux-gnu.tar.gz
martex-${VERSION}-arm-linux-gnueabihf.tar.gz
martex-${VERSION}-i686-pc-linux-gnu.tar.gz
martex-${VERSION}-riscv64-linux-gnu.tar.gz
martex-${VERSION}-x86_64-linux-gnu.tar.gz
martex-${VERSION}-osx64.tar.gz
martex-${VERSION}-osx.dmg
martex-${VERSION}.tar.gz
martex-${VERSION}-win64-setup.exe
martex-${VERSION}-win64.zip

The *-debug* files generated by the gitian build contain debug symbols for troubleshooting by developers. It is assumed that anyone that is interested in debugging can run gitian to generate the files for themselves. To avoid end-user confusion about which file to pick, as well as save storage space do not upload these to github.

  • GPG-sign it, delete the unsigned file:
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 GitHub release (see below)

  • Announce the release:

    • bitcointalk announcement thread

    • Optionally twitter, reddit /r/martexcoin, ... but this will usually sort out itself

    • Archive release notes for the new version to doc/release-notes/ (branch master and branch of the release)

    • Create a new GitHub release with a link to the archived release notes.

    • Celebrate