Improvement to release process doc.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
This commit is contained in:
parent
83aac13083
commit
26722e47c6
|
@ -4,7 +4,7 @@ Meta: There should always be a single release engineer to disambiguate responsib
|
||||||
|
|
||||||
## Pre-release
|
## Pre-release
|
||||||
|
|
||||||
Check all of the following:
|
The following should have been checked well in advance of the release:
|
||||||
|
|
||||||
- All dependencies have been updated as appropriate:
|
- All dependencies have been updated as appropriate:
|
||||||
- BDB
|
- BDB
|
||||||
|
@ -16,6 +16,9 @@ Check all of the following:
|
||||||
- miniupnpc
|
- miniupnpc
|
||||||
- OpenSSL
|
- OpenSSL
|
||||||
|
|
||||||
|
|
||||||
|
## Release process
|
||||||
|
|
||||||
## A. Define the release version as:
|
## A. Define the release version as:
|
||||||
|
|
||||||
$ ZCASH_RELEASE=MAJOR.MINOR.REVISION(-BUILD_STRING)
|
$ ZCASH_RELEASE=MAJOR.MINOR.REVISION(-BUILD_STRING)
|
||||||
|
@ -30,7 +33,10 @@ previous release:
|
||||||
$ ZCASH_RELEASE_PREV=1.0.0-beta1
|
$ ZCASH_RELEASE_PREV=1.0.0-beta1
|
||||||
|
|
||||||
## B. Create a new release branch / github PR
|
## B. Create a new release branch / github PR
|
||||||
### B1. Update (commit) version in sources
|
|
||||||
|
### B1. Check that you are up-to-date with current master, then create a release branch.
|
||||||
|
|
||||||
|
### B2. Update (commit) version in sources.
|
||||||
|
|
||||||
README.md
|
README.md
|
||||||
src/clientversion.h
|
src/clientversion.h
|
||||||
|
@ -63,7 +69,7 @@ Then perform the following command:
|
||||||
|
|
||||||
Commit the changes.
|
Commit the changes.
|
||||||
|
|
||||||
### B2. Write release notes
|
### B3. Generate release notes
|
||||||
|
|
||||||
Run the release-notes.py script to generate release notes and update authors.md file. For example:
|
Run the release-notes.py script to generate release notes and update authors.md file. For example:
|
||||||
|
|
||||||
|
@ -83,13 +89,13 @@ Update the Debian package changelog:
|
||||||
|
|
||||||
(`dch` comes from the devscripts package.)
|
(`dch` comes from the devscripts package.)
|
||||||
|
|
||||||
### B3. Change the network magics
|
### B4. Change the network magics
|
||||||
|
|
||||||
If this release breaks backwards compatibility, change the network magic
|
If this release breaks backwards compatibility, change the network magic
|
||||||
numbers. Set the four `pchMessageStart` in `CTestNetParams` in `chainparams.cpp`
|
numbers. Set the four `pchMessageStart` in `CTestNetParams` in `chainparams.cpp`
|
||||||
to random values.
|
to random values.
|
||||||
|
|
||||||
### B4. Merge the previous changes
|
### B5. Merge the previous changes
|
||||||
|
|
||||||
Do the normal pull-request, review, testing process for this release PR.
|
Do the normal pull-request, review, testing process for this release PR.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue