8000 Update release issue template by ghzlatarev · Pull Request #513 · Manta-Network/Manta · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Update release issue template #513

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 23, 2022
Merged

Update release issue template #513

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c289f3d
Update release template issue
ghzlatarev Apr 22, 2022
bc3ecc4
add note about not releasing from PR branches
ghzlatarev Apr 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 16 additions & 11 deletions .github/ISSUE_TEMPLATE/release.md
View file
Open in desktop
8000
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The following checks can be performed after we have frozen our release candidate
- [ ] Code freeze should typically happen one week prior to release, to ensure we have enough time for related testing.
- [ ] Notify everyone, especially people with merge rights to `manta` (stechu, Dengjianping) that a release is ongoing and no more merges to `manta` should happen until told otherwise
- [ ] Complete the following [manual QA workflow](https://hackmd.io/TbFmorG2RnOPmLuFcg9JOQ?view).
- [ ] Verify [Polkadot JS API](#polkadot-js) are up to date with the latest
- [ ] Verify Polkadot JS API are up to date with the latest
runtime changes.
- [ ] Execute runtime upgrade to Como and verify network stability.
- [ ] Execute runtime upgrade to Baikal and verify network stability.
Expand All @@ -37,21 +37,22 @@ The following checks can be performed after we have frozen our release candidate
### Client Releases

- [ ] Verify that each crate's `version` has been bumped from previous release.
- [ ] Check that the new client versions have [run on the network](#burn-in) without issue for 12 hours.
- [ ] Check that the new client versions have [burned-in](#burn-in) without issue for at least 12 hours.

### All Releases

- [ ] Check that a draft release has been created at
https://github.com/Manta-Network/Manta/releases with relevant [release
notes](#release-notes)
- [ ] Check that [build artifacts](#build-artifacts) have been added to the
- [ ] Check that build artifacts have been added to the
draft-release
- [ ] Coordinate with marketing team for documenation updates and other relevant tasks.
- [ ] Coordinate with marketing team for documentation updates and other relevant tasks.
- [ ] Update changelog.

Note: Do not publish draft releases from PR branches, because those branches will be deleted when the PR is merged.

### After Runtime Upgrade
- [ ] Notify subscan team. Ensure subscan service can continue to scan calamari blocks.
- [ ] Sidecar [update](https://github.com/paritytech/substrate-api-sidecar/blob/master/src/chains-config/metadata-consts/calamariConsts.ts#L6)

## Notes

Expand Down Expand Up @@ -86,25 +87,29 @@ client release

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`.

The things to look for in the output are lines like:
the `module index, call index` tuples map to the same set of functions. To generate a diff report you can do the following:
* Go to the [metadata diff tool page](https://github.com/Manta-Network/Manta/actions/workflows/metadata_diff.yml).
* Open `Run workflow` drop-down menu.
* Choose the branch you want to test and other inputs if the defaults are not applicable.
* Run the workflow.
* Wait for the job to complete and inspect the output. The things to look for in the `output.txt` are lines like:
- `[Identity] idx 28 -> 25 (calls 15)` - indicates the index for `Identity` has changed
- `[+] Society, Recovery` - indicates the new version includes 2 additional modules/pallets.
- If no indices have changed, every modules line should look something like `[Identity] idx 25 (calls 15)`

In case of a breaking change, bump the `transaction_version`.

Note: Adding new functions to the runtime does not constitute a breaking change
as long as the indexes did not change.

### Benchmarks

There are three benchmarking machines reserved for updating the weights at
release-time. To initialise a benchmark run for each production runtime
release-time. To initialize a benchmark run for each production runtime
(calamari, manta):
* Go to [Calamari Benchmarking Github Action](https://github.com/Manta-Network/Manta/actions/workflows/generate_calamari_weights_files.yml)
and [Manta Benchmarking Github Action](https://github.com/Manta-Network/Manta/actions/workflows/generate_manta_weights_files.yml)
* Open "Run workflow" drop-down menu.
* Open `Run workflow` drop-down menu.
* Choose your branch and run the workflow.
* When these jobs have completed (it takes a few hours), custom weights files will
be available to download as artifacts.
Expand Down
0