zcash-patched-for-explorer/doc/release-process.md

61 lines
1.5 KiB
Markdown
Raw Normal View History

2013-05-19 21:30:00 -07:00
Release Process
====================
### Define the release version as:
2013-05-19 21:30:00 -07:00
$ ZCASH_RELEASE=${UPSTREAM_VERSION}.z${ZCASH_RELEASE_COUNTER}
2013-05-19 21:30:00 -07:00
Example:
2013-05-19 21:30:00 -07:00
$ ZCASH_RELEASE=0.11.2.z2
2013-05-19 21:30:00 -07:00
Also, the following commands use the ZCASH_RELEASE_PREV bash variable
for the previous release:
2013-05-19 21:30:00 -07:00
$ ZCASH_RELEASE_PREV=0.11.2.z1
2013-05-19 21:30:00 -07:00
### update (commit) version in sources
2013-05-19 21:30:00 -07:00
doc/README.md
src/clientversion.h
2013-05-19 21:30:00 -07:00
In clientverion.h change CLIENT_VERSION_IS_RELEASE to false while Zcash
is in alpha-test phase.
2013-05-19 21:30:00 -07:00
### write release notes
2014-08-12 16:24:05 -07:00
git shortlog helps a lot, for example:
2014-08-12 16:24:05 -07:00
$ git shortlog --no-merges v${ZCASH_RELEASE_PREV}..HEAD \
> ./doc/release-notes/release-notes-${ZCASH_RELEASE}.md
2013-05-19 21:30:00 -07:00
### merge the previous changes
Do the normal pull-request, review, testing process.
### make tags / release-branch for the newly merged result
2013-05-19 21:30:00 -07:00
In this example, we ensure zc.v0.11.2.latest is up to date with the
previous merged PR, then:
$ git tag v${ZCASH_RELEASE}
$ git branch zc.v${ZCASH_RELEASE}
$ git push origin v${ZCASH_RELEASE}
$ git push origin zc.v${ZCASH_RELEASE}
### update github default branch to this new release branch
### write / publish a release announcement
2013-05-19 21:30:00 -07:00
### celebrate
### missing steps
Zcash still needs:
a. deterministic build
b. signatured tags
c. thorough pre-release testing (presumably more thorough than standard PR tests)
d. release deployment steps (eg: updating build-depends mirror, deploying testnet, etc...)
e. proper zcash-specific versions and names in software and documentation.