diff --git a/.github/PULL_REQUEST_TEMPLATE/release-checklist.md b/.github/PULL_REQUEST_TEMPLATE/release-checklist.md index ebbea0ca..6132da15 100644 --- a/.github/PULL_REQUEST_TEMPLATE/release-checklist.md +++ b/.github/PULL_REQUEST_TEMPLATE/release-checklist.md @@ -118,9 +118,9 @@ After you have the version increments, the updated checkpoints and the updated c - [ ] Make sure the PR with the new checkpoint hashes is already merged, or make it part of the changelog PR - [ ] Push the version increments and the updated changelog into a branch - (name suggestion, example: `v1.0.0-rc.X`) + (for example: `bump-v1.0.0-rc.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/v100-alpha0-release?expand=1&template=release-checklist.md)). + comparing url ([Example](https://github.com/ZcashFoundation/zebra/compare/v1.0.0-rc.0-release?expand=1&template=release-checklist.md)). - [ ] Add the list of deleted changelog entries as a comment to make reviewing easier. - [ ] Turn on [Merge Freeze](https://www.mergefreeze.com/installations/3676/branches). - [ ] Once the PR is ready to be merged, unfreeze it [here](https://www.mergefreeze.com/installations/3676/branches). @@ -148,7 +148,7 @@ After you have the version increments, the updated checkpoints and the updated c (You can ignore the full sync and `lightwalletd` tests, because they take about a day to run.) - [ ] [Publish the release to GitHub](https://github.com/ZcashFoundation/zebra/releases) by disabling 'pre-release', then clicking "Publish 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 zfnd/zebra:1.0.0-rc.` +- [ ] Test the Docker image using `docker run --tty --interactive zfnd/zebra:1.0.0-rc.` - [ ] Turn off [Merge Freeze](https://www.mergefreeze.com/installations/3676/branches) for the whole repository diff --git a/book/src/dev/audit.md b/book/src/dev/audit.md index 73827e7c..8107f534 100644 --- a/book/src/dev/audit.md +++ b/book/src/dev/audit.md @@ -1,6 +1,6 @@ # Zebra audits -In addition to our normal [release process](https://github.com/ZcashFoundation/zebra/blob/main/book/src/dev/release-process.md], we do these steps to prepare for an audit: +In addition to our normal [release process](https://github.com/ZcashFoundation/zebra/blob/main/book/src/dev/release-process.md), we do these steps to prepare for an audit: 1. [Tag a release candidate](https://github.com/ZcashFoundation/zebra/blob/main/book/src/dev/release-process.md#preview-releases) with the code to be audited 2. Declare a feature and fix freeze: non-essential changes must wait until after the audit, new features must be behind a [Rust feature flag](https://doc.rust-lang.org/cargo/reference/features.html) 3. Prepare a list of dependencies that are [in scope, partially in scope, and out of scope](https://github.com/ZcashFoundation/zebra/issues/5214). Audits focus on: