From d67b37a7a13e68d92c43bad068cda556d0ac0c5e Mon Sep 17 00:00:00 2001 From: teor Date: Sat, 10 Jun 2023 01:58:38 +1000 Subject: [PATCH] Fix release-checklist.md (#6883) --- .../release-checklist.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/release-checklist.md b/.github/PULL_REQUEST_TEMPLATE/release-checklist.md index 884b5631..1d7a1e4f 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release-checklist.md +++ b/.github/PULL_REQUEST_TEMPLATE/release-checklist.md @@ -61,7 +61,7 @@ You can use `fastmod` to interactively find and replace versions. For example, you can do something like: ``` -fastmod --extensions rs,toml,md --fixed-strings '1.0.0-rc.9' '1.0.0' zebrad README.md zebra-network/src/constants.rs book/src/user/docker.md +fastmod --extensions rs,toml,md --fixed-strings '1.0.0' '1.1.0' zebrad README.md zebra-network/src/constants.rs book/src/user/docker.md fastmod --extensions rs,toml,md --fixed-strings '1.0.0-beta.15' '1.0.0-beta.16' zebra-* fastmod --extensions rs,toml,md --fixed-strings '0.2.30' '0.2.31' tower-batch tower-fallback cargo build @@ -94,7 +94,8 @@ Sometimes `dependabot` misses some dependency updates, or we accidentally turned Here's how we make sure we got everything: - [ ] Run `cargo update` on the latest `main` branch, and keep the output - [ ] If needed, update [deny.toml](https://github.com/ZcashFoundation/zebra/blob/main/book/src/dev/continuous-integration.md#fixing-duplicate-dependencies-in-check-denytoml-bans) -- [ ] Open a separate PR with the changes, and add the output of `cargo update` to that PR as a comment +- [ ] Open a separate PR with the changes +- [ ] Add the output of `cargo update` to that PR as a comment ## Change Log @@ -136,8 +137,6 @@ Needed for the end of support feature. Please update the following constants [in - So for example if you think the release will be tagged somewhere in the next 3 days you can add `1152 * 3` to the current tip height and use that value here. -- [ ] `EOS_PANIC_AFTER` (optional) - Replace if you want the release to be valid for a different numbers of days into the future. The default here is 120 days. - ## Create the Release ### Create the Release PR @@ -148,7 +147,7 @@ and the updated changelog: - [ ] Make sure the PRs with the new checkpoint hashes and missed dependencies are already merged - [ ] Push the version increments, the updated changelog and the release constants into a branch (for example: `bump-v1.0.0` - this needs to be different to the tag name) -- [ ] Create a release PR by adding `&template=release-checklist.md` to the comparing url ([Example](https://github.com/ZcashFoundation/zebra/compare/v1.0.0-rc.0-release?expand=1&template=release-checklist.md)). +- [ ] Create a release PR by adding `&template=release-checklist.md` to the comparing url ([Example](https://github.com/ZcashFoundation/zebra/compare/bump-v1.0.0?expand=1&template=release-checklist.md)). - [ ] Add the list of deleted changelog entries as a comment to make reviewing easier. - [ ] Freeze the [`batched` queue](https://dashboard.mergify.com/github/ZcashFoundation/repo/zebra/queues) using Mergify. - [ ] Mark all the release PRs as `Critical` priority, so they go in the `urgent` Mergify queue. @@ -175,10 +174,9 @@ and the updated changelog: - [ ] Wait until the [pre-release deployment machines have successfully launched](https://github.com/ZcashFoundation/zebra/actions/workflows/continous-delivery.yml) - [ ] [Publish the release to GitHub](https://github.com/ZcashFoundation/zebra/releases) by disabling 'pre-release', then clicking "Set as the latest release" - [ ] Wait until [the Docker images have been published](https://github.com/ZcashFoundation/zebra/actions/workflows/release-binaries.yml) -- [ ] Test the Docker image using `docker run --tty --interactive zfnd/zebra`, +- [ ] Test the Docker image using `docker run --tty --interactive zfnd/zebra:v1.0.0`, and put the output in a comment on the PR. - (You can use [gcloud cloud shell](https://console.cloud.google.com/home/dashboard?cloudshell=true)) - + (You can use [gcloud cloud shell](https://console.cloud.google.com/home/dashboard?cloudshell=true)) - [ ] Un-freeze the [`batched` queue](https://dashboard.mergify.com/github/ZcashFoundation/repo/zebra/queues) using Mergify. @@ -186,9 +184,6 @@ and the updated changelog: - [ ] Post a summary of the important changes in the release in the `#arborist` and `#communications` Slack channels -If the release contains new features (`major` or `minor`), or high-priority bug fixes: -- [ ] Ask the team about doing a blog post - ## Release Failures If building or running fails after tagging: @@ -196,7 +191,7 @@ If building or running fails after tagging:
1. Fix the bug that caused the failure -2. Increment versions again, following these instructions from the start +2. Increment the patch version again, following these instructions from the start 3. Update the code and documentation with a **new** git tag 4. Update `CHANGELOG.md` with details about the fix 5. Tag a **new** release