This repository was archived by the owner on Nov 15, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Add release checklist #1316
Merged
Merged
Add release checklist #1316
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
8b6300b
Add release checklist
shawntabrizi b56a7e7
add space to checkbox
shawntabrizi ffc9a90
polkadot-js-apps
shawntabrizi c0d5985
Apply suggestions from code review
shawntabrizi 91e330d
add notes for each release item
joepetrowski 0c098dd
Apply suggestions from code review
shawntabrizi 8d52fb1
Apply suggestions from code review
shawntabrizi 62f4a2c
Update RELEASE.md
shawntabrizi 1060499
Update RELEASE.md - rearrange sections
s3krit e435115
Merge branch 'master' into shawntabrizi-release-checklist
shawntabrizi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| # Release Checklist | ||
|
|
||
| The following checks should be completed before releasing a new version of the | ||
| Polkadot/Kusama/Westend runtime or client: | ||
|
|
||
| ### All Releases | ||
|
|
||
| - [ ] Check that the new client releases have [run on the network](#burn-in) without issue for 24 | ||
shawntabrizi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| hours. | ||
| - [ ] Add [build artifacts](#build-artifacts) to the release. | ||
|
|
||
| ### Runtime Releases | ||
|
|
||
| - [ ] List any [native runtime](#native-runtimes) versions associated with the release. | ||
| - [ ] Increment [`spec_version`](#spec-version) for any native runtimes. | ||
shawntabrizi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - [ ] Verify [new migrations](#new-migrations) complete successfully, and the runtime state is | ||
| correctly updated. | ||
| - [ ] Verify previously [completed migrations](#old-migrations-removed) are removed. | ||
| - [ ] Verify pallet and [extrinsic ordering](#extrinsic-ordering) has stayed the same. Bump | ||
| `transaction_version` if not. | ||
| - [ ] Verify new extrinsics have been correctly whitelisted/blacklisted for | ||
| [proxy filters](#proxy-filtering). | ||
| - [ ] Verify [benchmarks](#benchmarks) have been updated for any modified runtime logic. | ||
| - [ ] Verify [Polkadot JS API](#polkadot-js) are up to date with the latest runtime changes. | ||
|
|
||
| ## Notes | ||
|
|
||
| ### Burn In | ||
|
|
||
| Ensure that Parity DevOps has run the new release on Westend, Kusama, and Polkadot validators for | ||
| at least 24 hours prior to publishing the release. | ||
shawntabrizi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Build Artifacts | ||
|
|
||
| Add any necessary assets to the release. They should include: | ||
|
|
||
| - Linux binary | ||
| - GPG signature | ||
shawntabrizi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - SHA256 of binary | ||
| - Source code | ||
| - Wasm binaries of any runtimes | ||
|
|
||
| ### Native Runtimes | ||
|
|
||
| The release notes should list which native runtimes and their versions are included. | ||
shawntabrizi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Spec Version | ||
|
|
||
| A runtime upgrade must bump the spec number. This may follow a pattern with the client release | ||
| (e.g. runtime v12 corresponds to v0.8.12, even if the current runtime is not v11). | ||
|
|
||
| ### New Migrations | ||
|
|
||
| Ensure that any migrations that are required due to storage or logic changes are included in the | ||
| `on_runtime_upgrade` function of the appropriate pallets. | ||
|
|
||
| ### Old Migrations Removed | ||
|
|
||
| Any previous `on_runtime_upgrade` functions from old upgrades must be removed to prevent them from | ||
| executing a second time. | ||
|
|
||
| ### Extrinsic Ordering | ||
|
|
||
| Offline signing libraries depend on a consistent ordering of call indices and functions. Compare | ||
| the metadata of the current and new runtimes and ensure that the `module index, call index` tuples | ||
| map to the same set of functions. In case of a breaking change, increase `transaction_version`. | ||
|
|
||
| Note: Adding new functions to the runtime does not constitute a breaking change as long as they are | ||
| added to the end of a pallet (i.e., does not break any other call index). | ||
|
|
||
| ### Proxy Filtering | ||
|
|
||
| The runtime contains proxy filters that map proxy types to allowable calls. If the new runtime | ||
| contains any new calls, verify that the proxy filters are up to date to include them. | ||
|
|
||
| ### Benchmarcks | ||
shawntabrizi marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Run the benchmarking suite with the new runtime and update any function weights if necessary. | ||
|
|
||
| ### Polkadot JS | ||
|
|
||
| Ensure that a release of [Polkadot JS API]() contains any new types or interfaces necessary to | ||
| interact with the new runtime. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.