Rewrite release-process.md and follow the example to generate a changelog-style release-notes file.
This commit is contained in:
Nathan Wilcox
35
doc/release-notes/release-notes-0.11.2.z2.md
Normal file
35
doc/release-notes/release-notes-0.11.2.z2.md
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
Daira Hopwood (2):
|
||||||
|
Add Code of Conduct. fixes #802
|
||||||
|
Specify Sean as the second contact for conduct issues.
|
||||||
|
|
||||||
|
Jack Grigg (6):
|
||||||
|
Implement validator and basic solver for Equihash
|
||||||
|
Add test vectors for Equihash
|
||||||
|
Use Equihash for Proof-of-Work
|
||||||
|
Adjust genesis blocks to have valid solutions and hashes
|
||||||
|
Fix tests that depend on old block header format
|
||||||
|
Fix pow_tests to work with Equihash
|
||||||
|
|
||||||
|
Nathan Wilcox (4):
|
||||||
|
Log all failing rpc tests concisely.
|
||||||
|
Apply a patch from Sean to update wallet to use our new founders-reward aware balances.
|
||||||
|
Fix (most) rpc tests by updating balances. zcpour, zcpourdoublespend, and txn_doublespend currently fail.
|
||||||
|
Update a bunch of docs by adding a banner, delete a bunch of known bitrot docs; does not update release-process.md.
|
||||||
|
|
||||||
|
Sean Bowe (5):
|
||||||
|
Fix miner_tests to work with equihash
|
||||||
|
Add missing synchronization that causes race condition in test.
|
||||||
|
Implementation of Founders' Reward.
|
||||||
|
Fix remaining RPC tests.
|
||||||
|
Change pchMessageStart for new testnet.
|
||||||
|
|
||||||
|
Taylor Hornby (8):
|
||||||
|
Add automated performance measurement system.
|
||||||
|
Add equihash solving benchmarks
|
||||||
|
Add JoinSplit verification benchmarks
|
||||||
|
Add verify equihash benchmark
|
||||||
|
Don't leave massif.out lying around after the benchmarks
|
||||||
|
Use a separate datadir for the benchmarks
|
||||||
|
Make benchmark specified by command-line arguments
|
||||||
|
Benchmark a random equihash input.
|
||||||
|
|
||||||
@@ -1,172 +1,60 @@
|
|||||||
Release Process
|
Release Process
|
||||||
====================
|
====================
|
||||||
|
|
||||||
* update translations (ping wumpus, Diapolo or tcatm on IRC)
|
### Define the release version as:
|
||||||
* see https://github.com/bitcoin/bitcoin/blob/master/doc/translation_process.md#syncing-with-transifex
|
|
||||||
|
|
||||||
* * *
|
$ ZCASH_RELEASE=${UPSTREAM_VERSION}.z${ZCASH_RELEASE_COUNTER}
|
||||||
|
|
||||||
###update (commit) version in sources
|
Example:
|
||||||
|
|
||||||
contrib/verifysfbinaries/verify.sh
|
$ ZCASH_RELEASE=0.11.2.z2
|
||||||
doc/README*
|
|
||||||
share/setup.nsi
|
|
||||||
src/clientversion.h (change CLIENT_VERSION_IS_RELEASE to true)
|
|
||||||
|
|
||||||
###tag version in git
|
Also, the following commands use the ZCASH_RELEASE_PREV bash variable
|
||||||
|
for the previous release:
|
||||||
|
|
||||||
git tag -s v(new version, e.g. 0.8.0)
|
$ ZCASH_RELEASE_PREV=0.11.2.z1
|
||||||
|
|
||||||
###write release notes. git shortlog helps a lot, for example:
|
### update (commit) version in sources
|
||||||
|
|
||||||
git shortlog --no-merges v(current version, e.g. 0.7.2)..v(new version, e.g. 0.8.0)
|
doc/README.md
|
||||||
|
src/clientversion.h
|
||||||
|
|
||||||
* * *
|
In clientverion.h change CLIENT_VERSION_IS_RELEASE to false while Zcash
|
||||||
|
is in alpha-test phase.
|
||||||
|
|
||||||
###update Gitian
|
### write release notes
|
||||||
|
|
||||||
In order to take advantage of the new caching features in Gitian, be sure to update to a recent version (`e9741525c` or later is recommended)
|
git shortlog helps a lot, for example:
|
||||||
|
|
||||||
###perform Gitian builds
|
$ git shortlog --no-merges v${ZCASH_RELEASE_PREV}..HEAD \
|
||||||
|
> ./doc/release-notes/release-notes-${ZCASH_RELEASE}.md
|
||||||
|
|
||||||
From a directory containing the bitcoin source, gitian-builder and gitian.sigs
|
### merge the previous changes
|
||||||
|
|
||||||
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)
|
Do the normal pull-request, review, testing process.
|
||||||
|
|
||||||
mkdir -p inputs
|
### make tags / release-branch for the newly merged result
|
||||||
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
|
|
||||||
|
|
||||||
Register and download the Apple SDK: (see OS X Readme for details)
|
In this example, we ensure zc.v0.11.2.latest is up to date with the
|
||||||
|
previous merged PR, then:
|
||||||
|
|
||||||
https://developer.apple.com/devcenter/download.action?path=/Developer_Tools/xcode_6.1.1/xcode_6.1.1.dmg
|
$ git tag v${ZCASH_RELEASE}
|
||||||
|
$ git branch zc.v${ZCASH_RELEASE}
|
||||||
|
$ git push origin v${ZCASH_RELEASE}
|
||||||
|
$ git push origin zc.v${ZCASH_RELEASE}
|
||||||
|
|
||||||
Using a Mac, create a tarball for the 10.9 SDK and copy it to the inputs directory:
|
### update github default branch to this new release branch
|
||||||
|
|
||||||
tar -C /Volumes/Xcode/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/ -czf MacOSX10.9.sdk.tar.gz MacOSX10.9.sdk
|
### write / publish a release announcement
|
||||||
|
|
||||||
###Optional: Seed the Gitian sources cache
|
### celebrate
|
||||||
|
|
||||||
By default, Gitian will fetch source files as needed. For offline builds, they can be fetched ahead of time:
|
### missing steps
|
||||||
|
|
||||||
make -C ../bitcoin/depends download SOURCES_PATH=`pwd`/cache/common
|
Zcash still needs:
|
||||||
|
|
||||||
Only missing files will be fetched, so this is safe to re-run for each build.
|
a. deterministic build
|
||||||
|
b. signatured tags
|
||||||
###Build Bitcoin Core for Linux, Windows, and OS X:
|
c. thorough pre-release testing (presumably more thorough than standard PR tests)
|
||||||
|
d. release deployment steps (eg: updating build-depends mirror, deploying testnet, etc...)
|
||||||
./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-linux.yml
|
e. proper zcash-specific versions and names in software and documentation.
|
||||||
./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 ../
|
|
||||||
./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-win.yml
|
|
||||||
./bin/gsign --signer $SIGNER --release ${VERSION}-win-unsigned --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-win.yml
|
|
||||||
mv build/out/bitcoin-*-win-unsigned.tar.gz inputs/bitcoin-win-unsigned.tar.gz
|
|
||||||
mv build/out/bitcoin-*.zip build/out/bitcoin-*.exe ../
|
|
||||||
./bin/gbuild --commit bitcoin=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-osx.yml
|
|
||||||
./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)/
|
|
||||||
|
|
||||||
###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 bitcoin-detached-sigs repository, which can be combined with the unsigned apps to create signed binaries.
|
|
||||||
|
|
||||||
Create the signed OS X binary:
|
|
||||||
|
|
||||||
pushd ./gitian-builder
|
|
||||||
./bin/gbuild -i --commit signature=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-osx-signer.yml
|
|
||||||
./bin/gsign --signer $SIGNER --release ${VERSION}-osx-signed --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-osx-signer.yml
|
|
||||||
mv build/out/bitcoin-osx-signed.dmg ../bitcoin-${VERSION}-osx.dmg
|
|
||||||
popd
|
|
||||||
|
|
||||||
Create the signed Windows binaries:
|
|
||||||
|
|
||||||
pushd ./gitian-builder
|
|
||||||
./bin/gbuild -i --commit signature=v${VERSION} ../bitcoin/contrib/gitian-descriptors/gitian-win-signer.yml
|
|
||||||
./bin/gsign --signer $SIGNER --release ${VERSION}-win-signed --destination ../gitian.sigs/ ../bitcoin/contrib/gitian-descriptors/gitian-win-signer.yml
|
|
||||||
mv build/out/bitcoin-*win64-setup.exe ../bitcoin-${VERSION}-win64-setup.exe
|
|
||||||
mv build/out/bitcoin-*win32-setup.exe ../bitcoin-${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 bitcoin.org server
|
|
||||||
into `/var/www/bin/bitcoin-core-${VERSION}`
|
|
||||||
|
|
||||||
- Update bitcoin.org version
|
|
||||||
|
|
||||||
- First, check to see if the Bitcoin.org maintainers have prepared a
|
|
||||||
release: https://github.com/bitcoin/bitcoin.org/labels/Releases
|
|
||||||
|
|
||||||
- If they have, it will have previously failed their Travis CI
|
|
||||||
checks because the final release files weren't uploaded.
|
|
||||||
Trigger a Travis CI rebuild---if it passes, merge.
|
|
||||||
|
|
||||||
- If they have not prepared a release, follow the Bitcoin.org release
|
|
||||||
instructions: https://github.com/bitcoin/bitcoin.org#release-notes
|
|
||||||
|
|
||||||
- After the pull request is merged, the website will automatically show the newest version within 15 minutes, as well
|
|
||||||
as update the OS download links. Ping @saivann/@harding (saivann/harding on Freenode) in case anything goes wrong
|
|
||||||
|
|
||||||
- Announce the release:
|
|
||||||
|
|
||||||
- Release sticky on bitcointalk: https://bitcointalk.org/index.php?board=1.0
|
|
||||||
|
|
||||||
- Bitcoin-development mailing list
|
|
||||||
|
|
||||||
- Update title of #bitcoin on Freenode IRC
|
|
||||||
|
|
||||||
- Optionally reddit /r/Bitcoin, ... but this will usually sort out itself
|
|
||||||
|
|
||||||
- Notify BlueMatt so that he can start building [https://launchpad.net/~bitcoin/+archive/ubuntu/bitcoin](the PPAs)
|
|
||||||
|
|
||||||
- Add release notes for the new version to the directory `doc/release-notes` in git master
|
|
||||||
|
|
||||||
- Celebrate
|
|
||||||
|
|||||||
Reference in New Issue
Block a user