Release Zebra 1.0.0-rc.3 #5928
Merged
Release Zebra 1.0.0-rc.3 #5928
Conversation
This file contains 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
teor2345
added
A-docs
|
Here are the deleted changelog entries, I made them unique using |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #5928 +/- ##
==========================================
+ Coverage 78.11% 78.13% +0.01%
==========================================
Files 310 310
Lines 38837 38837
==========================================
+ Hits 30339 30344 +5
+ Misses 8498 8493 -5 |
arya2
previously approved these changes
Jan 9, 2023
arya2
approved these changes
Jan 10, 2023
|
The docker image seems to work fine: |
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.
Closes #5785
Versioning
How to Increment Versions
Zebra follows semantic versioning.
Semantic versions look like: MAJOR
.MINOR.PATCH[-TAG.PRE-RELEASE]The draft
zebradchangelog will have an automatic version bump. This version is based on the labels on the PRs in the release.Check that the automatic
zebradversion increment is correct:If we're releasing a mainnet network upgrade, it is a
majorrelease:majorversion of all the Zebra crates.patchversion of the tower crates.If we're not releasing a mainnet network upgrade, check for features, major changes, deprecations, and removals. If this release has any, it is a
minorrelease:minorversion ofzebrad.pre-releaseversion of the other crates.patchversion of the tower crates.Otherwise, it is a
patchrelease:patchversion ofzebrad.pre-releaseversion of the other crates.patchversion of the tower crates.Zebra's Rust API is not stable or supported, so we keep all the crates on the same beta
pre-releaseversion.Version Locations
Once you know which versions you want to increment, you can find them in the:
zebrad (rc):
Cargo.tomlzebra-networkprotocol user agent: https://github.com/ZcashFoundation/zebra/blob/main/zebra-network/src/constants.rsREADME.mdbook/src/user/docker.mdcrates (pre-release):
Cargo.tomlstower (patch):
Cargo.tomlsauto-generated:
Cargo.lock: runcargo buildafter updating all theCargo.tomlsVersion Tooling
You can use
fastmodto interactively find and replace versions.For example, you can do something like:
If you use
fastmod, don't update versions inCHANGELOG.mdorzebra-dependencies-for-audit.md.README
Update the README to:
Check for changes in the
Dockerfilesince the last tag:git diff <previous-release-tag> docker/Dockerfile.Checkpoints
With every release and for performance reasons, we want to update the zebra checkpoints. More information on how to do this can be found in the zebra-checkpoints README.
To do this you will need a synchronized
zcashdnode. You can request help from other zebra team members to submit this PR if you can't make it yourself at the moment of the release.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)Change Categories
From "Keep a Changelog":
Addedfor new features.Changedfor changes in existing functionality.Deprecatedfor soon-to-be removed features.Removedfor now removed features.Fixedfor any bug fixes.Securityin case of vulnerabilities.Create the Release
Create the Release PR
After you have the version increments, the updated checkpoints and the updated changelog:
(for example:
bump-v1.0.0-rc.0- this needs to be different to the tag name)&template=release-checklist.mdto thecomparing url (Example).
Do not unfreeze the whole repository.
mainbranch using@mergifyio update. Then Mergify should merge it in-place.If it makes a merge PR instead, that PR will get cancelled by the merge freeze. So just merge the changelog PR manually.
Create the Release
by clicking the Edit icon in the draft release
for example:
v1.0.0-rc.0mainbranchZebrafollowed by the version tag,for example:
Zebra 1.0.0-rc.0changelog you created; starting just after the title
## [Zebra ...ofthe current version being released, and ending just before the title of
the previous release.
Binary Testing
main, and the quick tests have passed.(You can ignore the full sync and
lightwalletdtests, because they take about a day to run.)docker run --tty --interactive zfnd/zebra:1.0.0-rc.<version>Blog Post
If the release contains new features (
majororminor), or high-priority bug fixes:If building or running fails after tagging:
CHANGELOG.mdwith details about the fix