From 04568d25271affde50b67d90fa22c649e04ffa28 Mon Sep 17 00:00:00 2001 From: teor Date: Fri, 29 Sep 2023 08:53:30 +1000 Subject: [PATCH] change(release): Add "wait for a full sync" to the release checklist and ticket template (#7612) * Add a state full sync to the release-checklist.md * Add state test and freeze to release.md * Make testing requirement clearer Co-authored-by: Alfredo Garcia --------- Co-authored-by: Alfredo Garcia --- .github/ISSUE_TEMPLATE/release.md | 12 ++++++++++++ .github/PULL_REQUEST_TEMPLATE/release-checklist.md | 1 + 2 files changed, 13 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index fab41907d82..1dab363d981 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.github/ISSUE_TEMPLATE/release.md @@ -12,6 +12,18 @@ assignees: '' These release steps can be done a week before the release, in separate PRs. They can be skipped for urgent releases. +## State Full Sync Test + +To check consensus correctness, we want to test that the state format is valid after a full sync. (Format upgrades are tested in CI on each PR.) + +- [ ] Make sure there has been [at least one successful full sync test](https://github.com/ZcashFoundation/zebra/actions/workflows/continous-integration-docker.yml?query=event%3Aschedule) since the last state change, or +- [ ] Start a manual workflow run with a Zebra and `lightwalletd` full sync. + +State format changes can be made in `zebra-state` or `zebra-chain`. The state format can be changed by data that is sent to the state, data created within the state using `zebra-chain`, or serialization formats in `zebra-state` or `zebra-chain`. + +After the test has been started, or if it has finished already: +- [ ] Ask for a state code freeze in Slack. The freeze lasts until the release has been published. + ## Checkpoints For performance and security, we want to update the Zebra checkpoints in every release. diff --git a/.github/PULL_REQUEST_TEMPLATE/release-checklist.md b/.github/PULL_REQUEST_TEMPLATE/release-checklist.md index f51ae3bb18a..48efec453f5 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release-checklist.md +++ b/.github/PULL_REQUEST_TEMPLATE/release-checklist.md @@ -9,6 +9,7 @@ assignees: '' # Prepare for the Release +- [ ] Make sure there has been [at least one successful full sync test](https://github.com/ZcashFoundation/zebra/actions/workflows/continous-integration-docker.yml?query=event%3Aschedule) since the last state change, or start a manual full sync. - [ ] Make sure the PRs with the new checkpoint hashes and missed dependencies are already merged. (See the release ticket checklist for details)