Release 2.4.0 #9674
Merged
Release 2.4.0 #9674
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
arya2
reviewed
Jul 2, 2025
Co-authored-by: Arya <[email protected]>
oxarbitrage
approved these changes
Jul 11, 2025
|
This was referenced Jul 15, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
name: 'Release Checklist Template'
about: 'Checklist to create and publish a Zebra release'
title: 'Release Zebra (version)'
labels: 'A-release, C-exclude-from-changelog, P-Critical 🚑'
assignees: ''
Prepare for the Release
(See the release ticket checklist for details)
Summarise Release Changes
These steps can be done a few days before the release, in the same PR:
Change Log
Important: Any merge into
maindeletes any edits to the draft changelog.Once you are ready to tag a release, copy the draft changelog into
CHANGELOG.md.We use the Release Drafter workflow to automatically create a draft changelog. We follow the Keep a Changelog format.
To create the final change log:
CHANGELOG.md(there can be multiple draft releases)README
README updates can be skipped for urgent releases.
Update the README to:
Check for changes in the
Dockerfilesince the last tag:git diff <previous-release-tag> docker/Dockerfile.Cargo.tomlsYou can use a command like:
Create the Release PR
for example:
bump-v1.0.0- this needs to be different to the tag name&template=release-checklist.mdto the comparing url (Example).batchedqueue using Mergify.Criticalpriority, so they go in theurgentMergify queue.do-not-merge, because Mergify checks approved PRs against every commit, even when a queue is frozen.A-releasetag to the release pull request in order for thecheck_no_git_refs_in_cargo_lockto run.Zebra git sources dependencies
check_no_git_refs_in_cargo_lockcheck passes.This check runs automatically on pull requests with the
A-releaselabel. It must pass for crates to be published to crates.io. If the check fails, you should either halt the release process or proceed with the understanding that the crates will not be published on crates.io.Update Versions and End of Support
Update Zebra Version
Choose a Release Level
Zebra follows semantic versioning. Semantic versions look like: MAJOR.MINOR.PATCH[-TAG.PRE-RELEASE]
Choose a release level for
zebrad. Release levels are based on user-visible changes from the changelog:majorreleasesminorreleasespatchreleaseZebra's Rust API doesn't have any support or stability guarantees, so we keep all the
zebra-*andtower-*crates on a betapre-releaseversion.Update Crate Versions
If you're publishing crates for the first time, log in to crates.io,
and make sure you're a member of owners group.
Check that the release will work:
Update End of Support
The end of support height is calculated from the current blockchain height:
ESTIMATED_RELEASE_HEIGHTinend_of_support.rswith the height you estimate the release will be tagged.Optional: calculate the release tagging height
1152blocks for each day until the release1152 * 3to the current Mainnet block heightUpdate the Release PR
Publish the Zebra Release
Create the GitHub Pre-Release
for example:
v1.0.0mainbranchZebrafollowed by the version tag,for example:
Zebra 1.0.0starting just after the title
## [Zebra ...of the current version being released,and ending just before the title of the previous release.
Test the Pre-Release
main, and the quick tests have passed:Publish Release
Publish Crates
cargo logincargo cleanin the zebra repo (optional)cargo release publish --verbose --workspace --executecrates.io:cargo install --locked --force --version 1.minor.patch zebrad && ~/.cargo/bin/zebradand put the output in a comment on the PR.
Publish Docker Images
batchedqueue using Mergify.do-not-mergefrom the PRs you added it toRelease Failures
If building or running fails after tagging:
Tag a new release, following these instructions...
patchreleaseCHANGELOG.mdwith details about the fix