v1.0.0-rc.6 release #6314
Merged
v1.0.0-rc.6 release #6314
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
github-actions
bot
added
the
C-trivial
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #6314 +/- ##
=======================================
Coverage 77.71% 77.71%
=======================================
Files 304 304
Lines 39583 39583
=======================================
+ Hits 30761 30763 +2
+ Misses 8822 8820 -2 |
|
@dconnolly do you think you can merge #6295 and add it to the release ? Right now the code is merged (#6274) but not the docs so i think it will be good to have both in the same release even if it is not a big deal. Thanks. |
Approved! Will update the changelog accordingly |
|
All these were removed form the changelog. there could be repeated ones, the auto changelog repeated a lot in this release. i think we might need to review what it is doing and we should have a document describing what titles we need to use to have a better changelog. To be fair there were tons of dependency upgrades that had to be removed. Trivial TODO: put this in a PR comment, not the CHANGELOG
To me this are trivial too, they were in other sections. Can have duplicates.
|
oxarbitrage
requested review from
arya2 and
teor2345
and removed request for
a team
oxarbitrage
added
P-High 🔥
and removed
C-trivial
teor2345
reviewed
Mar 23, 2023
teor2345
reviewed
Mar 23, 2023
teor2345
reviewed
Mar 23, 2023
teor2345
reviewed
Mar 23, 2023
We've talked about doing this a few times in meetings, maybe it would help to open a ticket so we can schedule that work in a sprint?
I thought we had something like this, but I can't find it. Maybe it's in a google doc. We could move it from the google doc or write it again when we split out the release reference from the release checklist? Or we could add a note about naming the PR to the pull request template: |
Co-authored-by: teor <[email protected]>
github-actions
bot
added
the
C-trivial
dconnolly
commented
Mar 23, 2023
Co-authored-by: Deirdre Connolly <[email protected]>
teor2345
reviewed
Mar 23, 2023
teor2345
reviewed
Mar 23, 2023
teor2345
reviewed
Mar 23, 2023
Co-authored-by: teor <[email protected]>
teor2345
reviewed
Mar 23, 2023
Co-authored-by: teor <[email protected]>
teor2345
approved these changes
Mar 23, 2023
|
@Mergifyio update |
✅ Branch has been successfully updated |
|
I've un-frozen the PR and updated it to the latest (Mergify should merge it automatically in-place, but if it makes a merge PR and that gets blocked by merge freeze, we can merge this PR manually.) |
|
I'm doing the release now |
|
The release seems to work well: |
|
The release is done! |
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.
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 (beta):
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.Cargo.tomlsYou can use a command like:
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 the comparing 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
for example:
v1.0.0-rc.0mainbranchZebrafollowed by the version tag,for example:
Zebra 1.0.0-rc.0starting just after the title
## [Zebra ...of the 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:Release Failures
If building or running fails after tagging:
CHANGELOG.mdwith details about the fix