Merge #7881: Update release process

f154470 [contrib] Remove reference to sf and add doc to verify.sh (MarcoFalke) 182bec4 contrib: remove hardcoded version from verify.sh (Wladimir J. van der Laan) c907f4d doc: Update release process (Wladimir J. van der Laan)
2025-02-21 14:34:49 +01:00 · 2016-04-25 13:31:11 +02:00 · 2016-04-25 13:31:11 +02:00 · c4e8390047
commit c4e8390047
parent f9c2ac7232 f154470070
5 changed files with 198 additions and 120 deletions
--- a/contrib/README.md
+++ b/contrib/README.md
@ -51,5 +51,5 @@ Test and Verify Tools
 ### [TestGen](/contrib/testgen) ###
 Utilities to generate test vectors for the data-driven Bitcoin tests.

-### [Verify SF Binaries](/contrib/verifysfbinaries) ###
-This script attempts to download and verify the signature file SHA256SUMS.asc from SourceForge.
+### [Verify Binaries](/contrib/verifybinaries) ###
+This script attempts to download and verify the signature file SHA256SUMS.asc from bitcoin.org.
--- a/contrib/verifysfbinaries/README.md
+++ b/contrib/verifysfbinaries/README.md
@ -1,6 +1,13 @@
-### Verify Binaries ###
+### Verify Binaries
 This script attempts to download the signature file `SHA256SUMS.asc` from https://bitcoin.org.

 It first checks if the signature passes, and then downloads the files specified in the file, and checks if the hashes of these files match those that are specified in the signature file.

 The script returns 0 if everything passes the checks. It returns 1 if either the signature check or the hash check doesn't pass. If an error occurs the return value is 2.
+
+Usage:
+
+```sh
+./verify.sh bitcoin-core-0.11.2
+./verify.sh bitcoin-core-0.12.0
+```
--- a/contrib/verifysfbinaries/verify.sh
+++ b/contrib/verifysfbinaries/verify.sh
@ -23,9 +23,6 @@ BASEDIR="https://bitcoin.org/bin/"
 VERSIONPREFIX="bitcoin-core-"
 RCVERSIONSTRING="rc"

-#this URL is used if a version number is not specified as an argument to the script
-SIGNATUREFILE="$BASEDIR""$VERSIONPREFIX""0.10.4/""$RCSUBDIR""$SIGNATUREFILENAME"
-
 if [ ! -d "$WORKINGDIR" ]; then
   mkdir "$WORKINGDIR"
 fi
@ -53,7 +50,8 @@ if [ -n "$1" ]; then

   SIGNATUREFILE="$BASEDIR$SIGNATUREFILENAME"
 else
-   BASEDIR="${SIGNATUREFILE%/*}/"
+   echo "Error: need to specify a version on the command line"
+   exit 2
 fi

 #first we fetch the file containing the signature
--- a/doc/release-notes.md
+++ b/doc/release-notes.md
@ -1,6 +1,21 @@
 (note: this is a temporary file, to be added-to by anybody, and moved to
 release-notes at release time)

+Bitcoin Core version *version* is now available from:
+
+  <https://bitcoin.org/bin/bitcoin-core-*version*/>
+
+This is a new major version release, including new features, various bugfixes
+and performance improvements, as well as updated translations.
+
+Please report bugs using the issue tracker at github:
+
+  <https://github.com/bitcoin/bitcoin/issues>
+
+To receive security and update notifications, please subscribe to:
+
+  <https://bitcoincore.org/en/list/announcements/join/>
+
 Notable changes
 ===============

--- a/doc/release-process.md
+++ b/doc/release-process.md
@ -1,13 +1,22 @@
 Release Process
 ====================

-* Update translations (ping wumpus, Diapolo or tcatm on IRC) see [translation_process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#syncing-with-transifex)
-* Update [bips.md](bips.md) to account for changes since the last release.
-* Update hardcoded [seeds](/contrib/seeds)
+Before every release candidate:

-* * *
+* Update translations (ping wumpus on IRC) see [translation_process.md](https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#syncing-with-transifex)
+
+Before every minor and major release:
+
+* Update [bips.md](bips.md) to account for changes since the last release.
+* Update version in sources (see below)
+* Write release notes (see below)
+
+Before every major release:
+
+* Update hardcoded [seeds](/contrib/seeds/README.md), see [this pull request](https://github.com/bitcoin/bitcoin/pull/7415) for an example. 

 ### First time / New builders
+
 Check out the source code in the following directory hierarchy.

    cd /path/to/your/toplevel/build
@ -16,26 +25,38 @@ Check out the source code in the following directory hierarchy.
    git clone https://github.com/devrandom/gitian-builder.git
    git clone https://github.com/bitcoin/bitcoin.git

-###Bitcoin maintainers/release engineers, update (commit) version in sources
+### Bitcoin maintainers/release engineers, update version in sources

-	pushd ./bitcoin
-	contrib/verifysfbinaries/verify.sh
-	configure.ac
-	doc/README*
-	doc/Doxyfile
-	contrib/gitian-descriptors/*.yml
-	src/clientversion.h (change CLIENT_VERSION_IS_RELEASE to true)
+Update the following:

-	# tag version in git
+- `configure.ac`:
+    - `_CLIENT_VERSION_MAJOR`
+    - `_CLIENT_VERSION_MINOR`
+    - `_CLIENT_VERSION_REVISION`
+    - Don't forget to set `_CLIENT_VERSION_IS_RELEASE` to `true`
+- `src/clientversion.h`: (this mirrors `configure.ac` - see issue #3539)
+    - `CLIENT_VERSION_MAJOR`
+    - `CLIENT_VERSION_MINOR`
+    - `CLIENT_VERSION_REVISION`
+    - Don't forget to set `CLIENT_VERSION_IS_RELEASE` to `true`
+- `doc/README.md` and `doc/README_windows.txt`
+- `doc/Doxyfile`: `PROJECT_NUMBER` contains the full version
+- `contrib/gitian-descriptors/*.yml`: usually one'd want to do this on master after branching off the release - but be sure to at least do it before a new major release

-	git tag -s v(new version, e.g. 0.8.0)
-
-	# write release notes. git shortlog helps a lot, for example:
+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

-* * *
+(or ping @wumpus on IRC, he has specific tooling to generate the list of merged pulls
+and sort them into categories based on labels)
+
+Generate list of authors:
+
+    git log --format='%aN' "$*" | sort -ui | sed -e 's/^/- /'
+
+Tag version (or release candidate) in git
+
+    git tag -s v(new version, e.g. 0.8.0)

 ### Setup and perform Gitian builds

@ -58,12 +79,15 @@ Check out the source code in the following directory hierarchy.

    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

 Register and download the Apple SDK: see [OS X readme](README_osx.txt) for details.

@ -77,18 +101,23 @@ Check out the source code in the following directory hierarchy.

 By default, Gitian will fetch source files as needed. To cache them ahead of time:

+    pushd ./gitian-builder
    make -C ../bitcoin/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 bitcoin=/path/to/bitcoin,signature=/path/to/sigs {rest of arguments}
-```
+    popd
+
 The gbuild invocations below <b>DO NOT DO THIS</b> by default.

 ### Build and sign Bitcoin Core for Linux, Windows, and OS X:

+    pushd ./gitian-builder
    ./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml
    ./bin/gsign --signer $SIGNER --release ${VERSION}-linux --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml
    mv build/out/bitcoin-*.tar.gz build/out/src/bitcoin-*.tar.gz ../
@ -102,27 +131,28 @@ The gbuild invocations below <b>DO NOT DO THIS</b> by default.
    ./bin/gsign --signer $SIGNER --release ${VERSION}-osx-unsigned --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-osx.yml
    mv build/out/bitcoin-*-osx-unsigned.tar.gz inputs/bitcoin-osx-unsigned.tar.gz
    mv build/out/bitcoin-*.tar.gz build/out/bitcoin-*.dmg ../
+    popd

 Build output expected:

-  1. source tarball (bitcoin-${VERSION}.tar.gz)
-  2. linux 32-bit and 64-bit dist tarballs (bitcoin-${VERSION}-linux[32|64].tar.gz)
-  3. windows 32-bit and 64-bit unsigned installers and dist zips (bitcoin-${VERSION}-win[32|64]-setup-unsigned.exe, bitcoin-${VERSION}-win[32|64].zip)
-  4. OS X unsigned installer and dist tarball (bitcoin-${VERSION}-osx-unsigned.dmg, bitcoin-${VERSION}-osx64.tar.gz)
-  5. Gitian signatures (in gitian.sigs/${VERSION}-<linux|{win,osx}-unsigned>/(your Gitian key)/
+  1. source tarball (`bitcoin-${VERSION}.tar.gz`)
+  2. linux 32-bit and 64-bit dist tarballs (`bitcoin-${VERSION}-linux[32|64].tar.gz`)
+  3. windows 32-bit and 64-bit unsigned installers and dist zips (`bitcoin-${VERSION}-win[32|64]-setup-unsigned.exe`, `bitcoin-${VERSION}-win[32|64].zip`)
+  4. OS X unsigned installer and dist tarball (`bitcoin-${VERSION}-osx-unsigned.dmg`, `bitcoin-${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

-	gpg --import ../bitcoin/contrib/gitian-keys/*.pgp
+    gpg --import bitcoin/contrib/gitian-keys/*.pgp

 Verify the signatures

+    pushd ./gitian-builder
    ./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-linux ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml
    ./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-win-unsigned ../bitcoin/contrib/gitian-descriptors/gitian-win.yml
    ./bin/gverify -v -d ../gitian.sigs/ -r ${VERSION}-osx-unsigned ../bitcoin/contrib/gitian-descriptors/gitian-osx.yml
-
    popd

 ### Next steps:
@ -138,8 +168,9 @@ Commit your signature to gitian.sigs:
    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 [bitcoin-detached-sigs](https://github.com/bitcoin/bitcoin-detached-sigs) repository, which can be combined with the unsigned apps to create signed binaries.
+
+- 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 [bitcoin-detached-sigs](https://github.com/bitcoin/bitcoin-detached-sigs) repository, which can be combined with the unsigned apps to create signed binaries.

 Create (and optionally verify) the signed OS X binary:

@ -169,13 +200,29 @@ Commit your signature for the signed OS X/Windows binaries:
    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
+```
+
+The list of files should be:
+```
+bitcoin-${VERSION}-linux32.tar.gz
+bitcoin-${VERSION}-linux64.tar.gz
+bitcoin-${VERSION}-osx64.tar.gz
+bitcoin-${VERSION}-osx.dmg
+bitcoin-${VERSION}.tar.gz
+bitcoin-${VERSION}-win32-setup.exe
+bitcoin-${VERSION}-win32.zip
+bitcoin-${VERSION}-win64-setup.exe
+bitcoin-${VERSION}-win64.zip
+```
+
+- GPG-sign it, delete the unsigned file:
+```
 gpg --digest-algo sha256 --clearsign SHA256SUMS # outputs SHA256SUMS.asc
 rm SHA256SUMS
 ```
@ -185,6 +232,15 @@ Note: check that SHA256SUMS itself doesn't end up in SHA256SUMS, which is a spur
 - Upload zips and installers, as well as `SHA256SUMS.asc` from last step, to the bitcoin.org server
  into `/var/www/bin/bitcoin-core-${VERSION}`

+- A `.torrent` will appear in the directory after a few minutes. Optionally help seed this torrent. To get the `magnet:` URI use:
+```bash
+transmission-show -m <torrent file>
+```
+Insert the magnet URI into the announcement sent to mailing lists. This permits
+people without access to `bitcoin.org` to download the binary distribution.
+Also put it into the `optional_magnetlink:` slot in the YAML file for
+bitcoin.org (see below for bitcoin.org update instructions). 
+
 - Update bitcoin.org version

  - First, check to see if the Bitcoin.org maintainers have prepared a
@ -202,13 +258,15 @@ Note: check that SHA256SUMS itself doesn't end up in SHA256SUMS, which is a spur

 - Announce the release:

-  - Release sticky on bitcointalk: https://bitcointalk.org/index.php?board=1.0
+  - bitcoin-dev and bitcoin-core-dev mailing list

-  - Bitcoin-development mailing list
+  - Bitcoin Core announcements list https://bitcoincore.org/en/list/announcements/join/
+
+  - bitcoincore.org blog post

  - Update title of #bitcoin on Freenode IRC

-  - Optionally reddit /r/Bitcoin, ... but this will usually sort out itself
+  - Optionally twitter, reddit /r/Bitcoin, ... but this will usually sort out itself

  - Notify BlueMatt so that he can start building [the PPAs](https://launchpad.net/~bitcoin/+archive/ubuntu/bitcoin)