Update release documentation + checklist (#2079)

* add instructions for extrinsic verification

* update release documentation
This commit is contained in:
Martin Pugh
2020-12-07 13:46:35 +01:00
committed by GitHub
parent 286924fc2b
commit f4a6f9d9b2
4 changed files with 57 additions and 19 deletions
+18 -7
View File
@@ -3,14 +3,14 @@ Polkadot Release Process
### Branches
* release-candidate branch: The branch used for staging of the next release.
Named like `release-v0.8.26`
Named like `release-v0.8.26`
* release branch: The branch to which successful release-candidates are merged
and tagged with the new version. Named literally `release`.
### Notes
* The release-candidate branch *must* be made in the paritytech/polkadot repo in
order for release automation to work correctly
* Any new pushes/merges to the release-candidate branch (for example,
* Any new pushes/merges to the release-candidate branch (for example,
refs/heads/release-v0.8.26) will result in the rc index being bumped (e.g., v0.8.26-rc1
to v0.8.26-rc2) and new wasms built.
@@ -32,14 +32,25 @@ automated and require no human action.
completed
6. (optional) If a fix is required to the release-candidate:
1. Merge the fix with `master` first
2. Checkout the release-candidate branch and merge `master`
3. Revert all changes since the creation of the release-candidate that are
**not** required for the fix.
4. Push the release-candidate branch to Github - this is now the new release-
2. Cherry-pick the commit from `master` to `release-v0.8.26`, fixing any
merge conflicts. Try to avoid unnecessarily bumping crates.
3. Push the release-candidate branch to Github - this is now the new release-
candidate
4. Depending on the cherry-picked changes, it may be necessary to perform some
or all of the manual tests again.
7. Once happy with the release-candidate, perform the release using the release
script located at `scripts/release.sh` (or perform the steps in that script
manually):
- `./scripts/release.sh v0.8.26`
8. NOACTION: The HEAD of the `release` branch will be tagged with `v0.8.26`,
and a final release will be created on Github.
and a final draft release will be created on Github.
### Security releases
Occasionally there may be changes that need to be made to the most recently
released version of Polkadot, without taking *every* change to `master` since
the last release. For example, in the event of a security vulnerability being
found, where releasing a fixed version is a matter of some expediency. In cases
like this, the fix should first be merged with master, cherry-picked to a branch
forked from `release`, tested, and then finally merged with `release`. A
sensible versioning scheme for changes like this is `vX.Y.Z-1`.