Checklist for v0.5.2 release #1313
Labels
p:high
High priority, prioritize the resolution of this issue
t:maintenance
The issue describes necessary maintenance
Release Checklist
This is the release checklist for Zeitgeist v0.5.2. All following checks should be completed before publishing a new release of the Zeitgeist runtime or client.
Runtime Releases
These checks should be performed on the codebase prior to forking to a release-candidate branch.
spec_version
has been incremented since the last release for any native runtimes from any existing use on public (non-private/test) networks.transaction_version
if not.The following checks can be performed after we have forked off to the release-candidate branch or started an additional release candidate branch (rc-2, rc-3, etc)
All Releases
notes.
Notes
Build Artifacts
Add any necessary assets to the release. They should include:
Release Notes
The release notes should list:
The release notes may also list:
Spec Version
A runtime upgrade must bump the spec version 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).
Old Migrations Removed
Any previous
on_runtime_upgrade
functions from the old upgrades must be removed to prevent them from executing a second time.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.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 caseof a breaking change, increase
transaction_version
.To verify the order has not changed:
Build the Zeitgeist client from source:
git clone https://github.com/zeitgeistpm/zeitgeist.git zeitgeist-release && pushd zeitgeist-release > /dev/null && cargo build --features=parachain
Run the release-candidate binary using a local chain:
./target/debug/zeitgeist --chain=battery_station --tmp
Use
polkadot-js-tools
to compare the metadata:docker run --network host jacogr/polkadot-js-tools metadata wss://bsr.zeitgeist.pm ws://localhost:9944
Things to look for in the output are lines like:
[Identity] idx 28 -> 25 (calls 15)
- indicates the index forIdentity
has changed[+] Society, Recovery
- indicates the new version includes 2 additional modules/pallets.[Identity] idx 25 (calls 15)
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.
Benchmarks
Run the benchmarking suite with the new runtime and update any function weights
if necessary.
Based on Parity's release checklist for Polkadot
The text was updated successfully, but these errors were encountered: