chore: Release Zebra 1.0.0-beta.15

[teor2345]

Closes #5011

Versioning

Which Crates to Increment

To check if any of the top-level crates need version increments:

1. Go to the zebra GitHub code page: https://github.com/ZcashFoundation/zebra
2. Check if the last commit was a Zebra version bump, or something else

Alternatively you can:

• Use the github compare tool and check the main branch against the last tag (Example)
• Use git diff --stat <previous-release-tag> origin/main

Once you know which crates have changed:

• Increment the crates that have new commits since the last version update
• Increment any crates that depend on crates that have changed
• Keep a list of the crates that haven't been incremented, to include in the PR

How to Increment Versions

Zebra follows semantic versioning.

Semantic versions look like: MAJOR.MINOR.PATCH[-TAG.PRE-RELEASE]

Reviewing Version Bumps

Check for missed changes by going to:
https://github.com/ZcashFoundation/zebra/tree/<commit-hash>/
Where <commit-hash> is the hash of the last commit in the version bump PR.

If any Zebra or Tower crates have commit messages that are not a version bump, we have missed an update.
Also check for crates that depend on crates that have changed. They should get a version bump as well.

Version Locations

Once you know which versions you want to increment, you can find them in the:

• zebra* Cargo.tomls
• tower-* Cargo.tomls
• zebra-network protocol user agent: https://github.com/ZcashFoundation/zebra/blob/main/zebra-network/src/constants.rs
• README.md
• book/src/user/install.md
• Cargo.lock: automatically generated by cargo build

Version Tooling

You can use fastmod to interactively find and replace versions.

For example, you can do something like:

fastmod --extensions rs,toml,md --fixed-strings '1.0.0-beta.11' '1.0.0-beta.12'
fastmod --extensions rs,toml,md --fixed-strings '0.2.26' '0.2.27' tower-batch tower-fallback

If you use fastmod, don't update versions in CHANGELOG.md.

README

We should update the README to:

• Remove any "Known Issues" that have been fixed
• Update the "Build and Run Instructions" with any new dependencies.
  Check for changes in the Dockerfile since 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 zcashd node. 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 main deletes any edits to the draft changelog.
Once you are ready to tag a release, copy the draft changelog into CHANGELOG.md.

We follow the Keep a Changelog format.

We use the Release Drafter workflow to automatically create a draft changelog.

To create the final change log:

• Copy the draft changelog into CHANGELOG.md
• Delete any trivial changes. Keep the list of those, to include in the PR
• Combine duplicate changes
• Edit change descriptions so they are consistent, and make sense to non-developers
• Check the category for each change
  • Prefer the "Fix" category if you're not sure

Change Categories

From "Keep a Changelog":

• Added for new features.
• Changed for changes in existing functionality.
• Deprecated for soon-to-be removed features.
• Removed for now removed features.
• Fixed for any bug fixes.
• Security in case of vulnerabilities.

Create the Release

Create the Release PR

After you have the version increments, the updated checkpoints and the updated changelog:

• Make sure the PR with the new checkpoint hashes is already merged.
• Push the version increments and the updated changelog into a branch
  (name suggestion, example: v1.0.0-alpha.0-release)
• Create a release PR by adding &template=release-checklist.md to the
  comparing url (Example).
  • Add the list of deleted changelog entries as a comment to make reviewing easier.
  • Also add the list of not-bumped crates as a comment (can use the same comment as the previous one).
• Turn on Merge Freeze.
• Once the PR is ready to be merged, unfreeze it here.
  Do not unfreeze the whole repository.

Create the Release

• Once the PR has been merged,
  create a new release using the draft release as a base,
  by clicking the Edit icon in the draft release
• Set the tag name to the version tag,
  for example: v1.0.0-alpha.0
• Set the release to target the main branch
• Set the release title to Zebra followed by the version tag,
  for example: Zebra 1.0.0-alpha.0
• Replace the prepopulated draft changelog in the release description by the final
  changelog you created; starting just after the title ## [Zebra ... of
  the current version being released, and ending just before the title of
  the previous release.
• Mark the release as 'pre-release', until it has been built and tested
• Publish the pre-release to GitHub using "Publish Release"

Build and Binary Testing

• After tagging the release, test that the exact cargo install command in README.md works
  (--git behaves a bit differently to --path)
• Test that the newly built Zebra starts correctly, by running ~/.cargo/bin/zebrad
• Wait until the Docker binaries have been built on main, and the quick tests have passed.
  (You can ignore the full sync and lightwalletd tests, because they take about a day to run.)
• Publish the release to GitHub by disabling 'pre-release', then clicking "Publish Release"
• Wait until the Docker images have been published
• Turn off Merge Freeze for the whole repository

If the build fails after tagging:

1. Fix the build
2. Increment versions again, following these instructions from the start
3. Update README.md with a new git tag
4. Update CHANGELOG.md with details about the fix
5. Tag a new release

[teor2345]

Here's how I made the release PR:

• All crates needed version bumps
• I didn't update the checkpoints, they were just updated last week

I combined or deleted these PRs in the draft changelog:

• build(deps): bump tokio from 1.21.0 to 1.21.1 (build(deps): bump tokio from 1.21.0 to 1.21.1 #5150)
• build(deps): bump semver from 1.0.13 to 1.0.14 (build(deps): bump semver from 1.0.13 to 1.0.14 #5176)
• Fix typos in release-process.md (Update release-process.md #5181)
• build(deps): bump thiserror from 1.0.34 to 1.0.35 (build(deps): bump thiserror from 1.0.34 to 1.0.35 #5160)
• build(deps): bump tj-actions/changed-files from 29.0.6 to 29.0.7 (build(deps): bump tj-actions/changed-files from 29.0.6 to 29.0.7 #5159)
• build(deps): bump itertools from 0.10.3 to 0.10.4 (build(deps): bump itertools from 0.10.3 to 0.10.4 #5149)
• build(deps): bump tj-actions/changed-files from 29.0.4 to 29.0.6 (build(deps): bump tj-actions/changed-files from 29.0.4 to 29.0.6 #5148)
• build(deps): bump criterion from 0.3.6 to 0.4.0 (build(deps): bump criterion from 0.3.6 to 0.4.0 #5136)
• build(deps): bump serde_with from 2.0.0 to 2.0.1 (build(deps): bump serde_with from 2.0.0 to 2.0.1 #5135)
• build(deps): bump tj-actions/changed-files from 29.0.3 to 29.0.4 (build(deps): bump tj-actions/changed-files from 29.0.3 to 29.0.4 #5117)
• build(deps): bump tokio-util from 0.7.3 to 0.7.4 (build(deps): bump tokio-util from 0.7.3 to 0.7.4 #5118)
• build(deps): bump prost, tonic, tonic-build and console-subscriber (build(deps): bump prost, tonic, tonic-build and console-subscriber #5009)
• build(deps): bump thiserror from 1.0.33 to 1.0.34 (build(deps): bump thiserror from 1.0.33 to 1.0.34 #5074)
• build(deps): bump tj-actions/changed-files from 29.0.2 to 29.0.3 (build(deps): bump tj-actions/changed-files from 29.0.2 to 29.0.3 #5073)
• change(deps): bump rocksdb from 0.18.0 to 0.19.0 (change(deps): bump rocksdb from 0.18.0 to 0.19.0 #5071)
• build(deps): bump owo-colors from 3.4.0 to 3.5.0 (build(deps): bump owo-colors from 3.4.0 to 3.5.0 #5037)
• build(deps): bump pin-project from 1.0.11 to 1.0.12 (build(deps): bump pin-project from 1.0.11 to 1.0.12 #4914)
• build(deps): bump futures from 0.3.23 to 0.3.24 (build(deps): bump futures from 0.3.23 to 0.3.24 #5020)
• build(deps): bump once_cell from 1.13.0 to 1.14.0 (build(deps): bump once_cell from 1.13.0 to 1.14.0 #5057)
• build(deps): bump tokio from 1.20.1 to 1.21.0 (build(deps): bump tokio from 1.20.1 to 1.21.0 #5058)
• build(deps): bump futures-util from 0.3.23 to 0.3.24 (build(deps): bump futures-util from 0.3.23 to 0.3.24 #5047)
• build(deps): bump chrono from 0.4.20 to 0.4.22 (build(deps): bump chrono from 0.4.20 to 0.4.22 #4984)
• build(deps): bump serde_json from 1.0.83 to 1.0.85 (build(deps): bump serde_json from 1.0.83 to 1.0.85 #5021)
• build(deps): bump futures-core from 0.3.23 to 0.3.24 (build(deps): bump futures-core from 0.3.23 to 0.3.24 #4998)
• fix(clippy): fix a new nightly Rust clippy "unwrap_or_else uses default" lint (fix(clippy): Fix a new nightly clippy "unwrap_or_else uses default" lint #5131)
• fix(clippy): Resolve unnecessary borrow lint and remove redundant imports (fix(clippy): Resolve unnecessary borrow lint and remove redundant imports #5045)
• ci(build): re-enable Rust beta tests in ubuntu (ci(build): re-enable Rust beta tests in ubuntu #5024)
• Document how to resolve disk full errors in CI (doc(ci): Document how to resolve disk full errors #5105)
• Explain how Mergify works, and how it can be used by developers (add(doc): Explain how Mergify works, and when it can be used #5100)
• Explain how to find errors in CI (update(doc): Explain how to find errors in CI #5080)
• fix(doc): Continious integration book doc (fix(doc): Continious integration book doc #5038)
• change(doc): Make the release instructions more explicit (change(doc): Make the release instructions more explicit #5026)
• build(deps): bump futures-util from 0.3.21 to 0.3.23 (build(deps): bump futures-util from 0.3.21 to 0.3.23 #4916)
• build(deps): bump vergen from 7.3.2 to 7.4.2 (build(deps): bump vergen from 7.3.2 to 7.4.2 #5022)
• build(deps): bump google-github-actions/auth from 0.8.0 to 0.8.1 (build(deps): bump google-github-actions/auth from 0.8.0 to 0.8.1 #5029)
• build(deps): bump bech32 from 0.9.0 to 0.9.1 (build(deps): bump bech32 from 0.9.0 to 0.9.1 #4912)
• deps(build): Bump insta to 1.19.1 (deps(build): Bump insta to 1.19.1 #5018)
• build(deps): bump thiserror from 1.0.32 to 1.0.33 (build(deps): bump thiserror from 1.0.32 to 1.0.33 #5019)
• doc(ci): Explain how to resolve duplicate dependency warnings (doc(ci): Explain how to resolve duplicate dependency warnings #5017)

[codecov]

Codecov Report

Merging #5194 (bd6f0b8) into main (202dc43) will increase coverage by 0.12%.
The diff coverage is n/a.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5194      +/-   ##
==========================================
+ Coverage   79.14%   79.27%   +0.12%     
==========================================
  Files         307      307              
  Lines       39218    39218              
==========================================
+ Hits        31040    31090      +50     
+ Misses       8178     8128      -50     

[upbqdn]

All looks good. I'm requesting changes just because of two small typos.

[upbqdn]

I realized it's easier to approve the PR since we don't merge PRs until all conversations are resolved anyway. (It's funny because I've been doing it this way for ages. I don't know what I was thinking when I was requesting the changes.)

[dconnolly]

Reviewed and tested cargo install --locked --git https://github.com/ZcashFoundation/zebra --branch beta-15-release zebra on macOS 12.6 on an M1, installed and ran successfully