Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish next Zebra release: 2.x.x #8997

Open
17 tasks
mpguerra opened this issue Nov 6, 2024 · 0 comments
Open
17 tasks

Publish next Zebra release: 2.x.x #8997

mpguerra opened this issue Nov 6, 2024 · 0 comments
Assignees
Labels
A-release Area: Zebra releases and release management C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG P-Medium ⚡

Comments

@mpguerra
Copy link
Contributor

mpguerra commented Nov 6, 2024

Prepare for the Release

These release steps can be done a week before the release, in separate PRs.
They can be skipped for urgent releases.

State Full Sync Test

To check consensus correctness, we want to test that the state format is valid after a full sync. (Format upgrades are tested in CI on each PR.)

State format changes can be made in zebra-state or zebra-chain. The state format can be changed by data that is sent to the state, data created within the state using zebra-chain, or serialization formats in zebra-state or zebra-chain.

After the test has been started, or if it has finished already:

  • Ask for a state code freeze in Slack. The freeze lasts until the release has been published.

Checkpoints

For performance and security, we want to update the Zebra checkpoints in every release.

Missed Dependency Updates

Sometimes dependabot misses some dependency updates, or we accidentally turned them off.

This step can be skipped if there is a large pending dependency upgrade. (For example, shared ECC crates.)

Here's how we make sure we got everything:

  • Run cargo update on the latest main branch, and keep the output
  • If needed, add duplicate dependency exceptions to deny.toml
  • If needed, remove resolved duplicate dependencies from deny.toml
  • Open a separate PR with the changes
  • Add the output of cargo update to that PR as a comment

Prepare and Publish the Release

Follow the steps in the release checklist to prepare the release:

Release PR:

  • Update Changelog
  • Update README
  • Update Zebra Versions
  • Update End of Support Height

Publish Release:

  • Create & Test GitHub Pre-Release
  • Publish GitHub Release
  • Publish Rust Crates
  • Publish Docker Images
@mpguerra mpguerra added A-release Area: Zebra releases and release management C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG P-Medium ⚡ labels Nov 6, 2024
@mpguerra mpguerra added this to Zebra Nov 6, 2024
@github-project-automation github-project-automation bot moved this to New in Zebra Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-release Area: Zebra releases and release management C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG P-Medium ⚡
Projects
Status: New
Development

No branches or pull requests

2 participants