-
Notifications
You must be signed in to change notification settings - Fork 107
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
Release v1.0.0-rc.4 #6045
Release v1.0.0-rc.4 #6045
Conversation
The following were pull requests in the draft changelog trivial section:
In addition to those i removed the following from the final changelog:
Additional removals from review:
|
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #6045 +/- ##
==========================================
- Coverage 78.25% 78.20% -0.06%
==========================================
Files 312 312
Lines 39418 39418
==========================================
- Hits 30846 30826 -20
- Misses 8572 8592 +20 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, I made some suggestions to explain the impact of each security issue, and I found some changes that might be trivial.
I pushed some checkpoints generated from |
Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for these fixes, looks good to me!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Happy to merge with or without the section name change
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your patience with all these changes!
@Mergifyio update |
☑️ Nothing to do
|
I deleted the old draft release, and I did the docker test: $ docker run --tty --interactive zfnd/zebra:1.0.0-rc.4
Unable to find image 'zfnd/zebra:1.0.0-rc.4' locally 1.0.0-rc.4: Pulling from zfnd/zebra
8740c948ffd4: Pull complete 0aaaffc1304a: Pull complete
99f06d586cd6: Pull complete c5bf8c144a72: Pull complete
e6542dc6fbf3: Pull complete
2ea9cf5096a3: Pull complete
Digest: sha256:74f0eb3c99055322a727b4483ff9215a91432b8c2a411b60ada426a9a68affa4
Status: Downloaded newer image for zfnd/zebra:1.0.0-rc.4
[sentry] initialized disabled sentry client due to disabled or invalid DSN
2023-01-31T22:47:23.228902Z INFO zebrad::components::tracing::component: started tracing component filter="info" TRACING_STATIC_MAX_LEVEL=LevelFilter::INFO LOG_STATIC_MAX_LEVEL=Info
2023-01-31T22:47:23.229079Z INFO zebrad::components::tracing::component: installed sentry tracing layer
2023-01-31T22:47:23.229093Z INFO zebrad::application: Diagnostic Metadata:
version: 1.0.0-rc.4
Zcash network: Mainnet
state version: 25
target triple: x86_64-unknown-linux-gnu
build profile: release
2023-01-31T22:47:23.229110Z INFO zebrad::application: loaded zebrad config config_path=Some("/etc/zebra/zebrad.toml") config=ZebradConfig { consensus: Config { checkpoint_sync: true, debug_skip_parameter_preload: false }, metrics: Config { endpoint_addr: None }, network: Config { listen_addr: 0.0.0.0:8233, network: Mainnet, initial_mainnet_peers: {"dnsseed.z.cash:8233", "dnsseed.str4d.xyz:8233", "mainn
et.seeder.zfnd.org:8233", "mainnet.is.yolo.money:8233"}, initial_testnet_peers: {"dnsseed.testnet.z.cash:18233", "testnet.seeder.zfnd.org:18233", "testnet.is.yolo.money:18233"}, peerset_initial_target_size: 25, crawl_new_peer_interval: 61s }, state: Config { cache_dir: "/zebrad-cache", ephemeral: false, debug_stop_at_height: None, delete_old_database: true }, tracing: Config { use_color: true, force_use
_color: false, filter: None, buffer_limit: 128000, endpoint_addr: None, flamegraph: None, use_journald: false }, sync: Config { download_concurrency_limit: 50, checkpoint_verify_concurrency_limit: 1000,
full_verify_concurrency_limit: 20, parallel_cpu_threads: 0 }, mempool: Config { tx_cost_limit: 80000000, eviction_memory_time: 3600s, debug_enable_at_height: None }, rpc: Config { listen_addr: None, para
llel_cpu_threads: 0, debug_force_finished_sync: false } }
2023-01-31T22:47:23.230051Z INFO {net="Main"}: zebrad::application: initialized rayon thread pool for CPU-bound tasks num_threads=36
2023-01-31T22:47:23.256559Z INFO {net="Main"}: zebrad::commands::start: Starting zebrad
2023-01-31T22:47:23.277872Z INFO {net="Main"}: zebrad::commands::start: initializing node state 2023-01-31T22:47:23.285161Z INFO {net="Main"}: zebrad::commands::start: opening database, this may take a few minutes 2023-01-31T22:47:23.286802Z INFO zebra_state::service::finalized_state::disk_db: the open file limit is high enough for Zebra current_limit=1048576 min_limit=512 ideal_limit=1024
2023-01-31T22:47:23.448264Z INFO zebra_state::service::finalized_state::disk_db: Opened Zebra state cache at /zebrad-cache/state/v25/mainnet
2023-01-31T22:47:23.448629Z INFO zebra_state::service::finalized_state: loaded Zebra state cache tip=None
2023-01-31T22:47:23.449056Z INFO zebra_state::service: starting legacy chain check
2023-01-31T22:47:23.449090Z INFO zebra_state::service: cached state consensus branch is valid: no legacy chain found
2023-01-31T22:47:23.449513Z INFO {net="Main"}: zebrad::commands::start: initializing network
2023-01-31T22:47:23.458726Z INFO {net="Main"}:open_listener{addr=0.0.0.0:8233}: zebra_network::peer_set::initialize: Trying to open Zcash protocol endpoint at 0.0.0.0:8233...
2023-01-31T22:47:23.458795Z INFO {net="Main"}:open_listener{addr=0.0.0.0:8233}: zebra_network::peer_set::initialize: Opened Zcash protocol endpoint at 0.0.0.0:8233
2023-01-31T22:47:23.459699Z INFO {net="Main"}: zebra_network::address_book_updater: starting the address book updater
2023-01-31T22:47:23.925525Z INFO {net="Main"}:add_initial_peers: zebra_network::config: resolved seed peer IP addresses seed="mainnet.seeder.zfnd.org:8233" remote_ip_count=25
2023-01-31T22:47:24.050174Z INFO {net="Main"}:add_initial_peers: zebra_network::config: resolved seed peer IP addresses seed="dnsseed.z.cash:8233" remote_ip_count=25
2023-01-31T22:47:24.301110Z INFO {net="Main"}:add_initial_peers: zebra_network::config: resolved seed peer IP addresses seed="dnsseed.str4d.xyz:8233" remote_ip_count=25
2023-01-31T22:47:24.342051Z INFO {net="Main"}:add_initial_peers: zebra_network::config: resolved seed peer IP addresses seed="mainnet.is.yolo.money:8233" remote_ip_count=4
2023-01-31T22:47:24.342137Z INFO {net="Main"}:add_initial_peers: zebra_network::peer_set::initialize: limiting the initial peers list from 62 to 25
2023-01-31T22:47:24.342271Z INFO {net="Main"}:add_initial_peers: zebra_network::peer_set::initialize: connecting to initial peer set initial_peer_count=25 initial_peers={5.2.75.10:8233, 8.214.158.97:823
3, 47.254.176.240:8233, [2a01:4f8:b0:920a::5502]:8233, 46.4.65.10:8233, 18.189.228.115:8233, 112.65.166.69:8233, 47.254.69.198:8233, 95.217.78.170:8233, 162.19.139.182:8233, 47.243.196.68:8233, 135.148.5
5.16:8233, 85.214.219.243:8233, 195.201.111.115:8233, 203.96.179.202:8233, 84.75.28.247:8233, 3.72.134.66:8233, 18.217.102.40:8233, 76.19.236.20:8233, 51.77.64.59:8233, 47.75.194.174:8233, 149.56.29.232:
8233, 78.46.46.252:8233, 47.242.8.170:8233, 162.55.103.190:8233}
2023-01-31T22:47:25.149539Z INFO {net="Main"}:add_initial_peers: zebra_network::peer_set::initialize: an initial peer connection failed successes=8 errors=2 addr=46.4.65.10:8233 e=Peer offered obsolete
version: Version(170002)
2023-01-31T22:47:25.282436Z INFO {net="Main"}:add_initial_peers: zebra_network::peer_set::initialize: an initial peer connection failed successes=11 errors=3 addr=18.217.102.40:8233 e=Serialization erro
r
2023-01-31T22:47:27.494986Z INFO {net="Main"}:add_initial_peers: zebra_network::peer_set::initialize: an initial peer connection failed successes=21 errors=4 addr=112.65.166.69:8233 e=request timed out
2023-01-31T22:47:27.495088Z INFO {net="Main"}:add_initial_peers: zebra_network::peer_set::initialize: finished connecting to initial seed peers handshake_success_total=21 handshake_error_total=4 outboun
d_connections=20
2023-01-31T22:47:27.495171Z INFO {net="Main"}: zebra_network::peer_set::initialize: sending initial request for peers active_initial_peer_count=20
2023-01-31T22:47:27.495935Z INFO {net="Main"}: zebrad::commands::start: initializing verifiers
2023-01-31T22:47:27.496371Z INFO {net="Main"}:init{config=Config { checkpoint_sync: true, debug_skip_parameter_preload: false } network=Mainnet debug_skip_parameter_preload=false}: zebra_consensus::prim
itives::groth16::params: checking and loading Zcash Sapling and Sprout parameters
2023-01-31T22:47:27.497898Z INFO {net="Main"}:crawl_and_dial{new_peer_interval=61s}: zebra_network::peer_set::initialize: starting the peer address crawler crawl_new_peer_interval=61s outbound_connectio
ns=20
2023-01-31T22:47:27.507136Z INFO {net="Main"}:init{config=Config { checkpoint_sync: true, debug_skip_parameter_preload: false } network=Mainnet debug_skip_parameter_preload=false}: zebra_consensus::chai
n: initializing chain verifier tip=None max_checkpoint_height=Height(1965904)
2023-01-31T22:47:27.508285Z INFO {net="Main"}: zebrad::commands::start: initializing syncer
2023-01-31T22:47:27.508367Z INFO {net="Main"}: zebrad::commands::start: initializing mempool
2023-01-31T22:47:27.508456Z INFO {net="Main"}: zebrad::commands::start: spawned initial Zebra tasks
2023-01-31T22:47:27.508491Z INFO {net="Main"}: zebra_state::config: checking for old database versions
2023-01-31T22:47:27.508520Z INFO {net="Main"}: zebrad::components::mempool::crawler: initializing mempool crawler task
2023-01-31T22:47:27.508541Z INFO {net="Main"}: zebrad::components::mempool::queue_checker: initializing mempool queue checker task
2023-01-31T22:47:27.508584Z INFO {net="Main"}: zebrad::components::sync::gossip: initializing block gossip task
2023-01-31T22:47:27.509130Z INFO {net="Main"}: zebra_state::config: finished old database version cleanup task
2023-01-31T22:47:27.509179Z INFO {net="Main"}: zebrad::components::mempool::gossip: initializing transaction gossip task
2023-01-31T22:47:27.509482Z INFO {net="Main"}:sync: zebrad::components::sync: starting genesis block download and verify
2023-01-31T22:47:27.514182Z INFO {net="Main"}: zebrad::components::sync::progress: initial sync is waiting to download the genesis block sync_percent=0.000 % current_height=None
2023-01-31T22:47:27.798983Z INFO {net="Main"}:sync:checkpoint: zebra_consensus::checkpoint: verified checkpoint range block_count=1 current_range=(Unbounded, Included(Height(0)))
2023-01-31T22:47:27.913993Z INFO {net="Main"}:sync:try_to_sync: zebrad::components::sync: starting sync, obtaining new tips state_tip=Some(Height(0))
2023-01-31T22:47:28.806219Z INFO {net="Main"}:init{config=Config { checkpoint_sync: true, debug_skip_parameter_preload: false } network=Mainnet debug_skip_parameter_preload=false}: zebra_consensus::prim
itives::groth16::params: Zcash Sapling and Sprout parameters downloaded and/or verified
2023-01-31T22:47:32.840637Z INFO {net="Main"}:sync:try_to_sync:obtain_tips:checkpoint: zebra_consensus::checkpoint: verified checkpoint range block_count=400 current_range=(Excluded(Height(0)), Included
(Height(400)))
2023-01-31T22:47:32.889849Z INFO {net="Main"}:sync:try_to_sync: zebrad::components::sync: extending tips tips.len=1 in_flight=371 extra_hashes=0 lookahead_limit=1000 state_tip=Some(Height(381))
... |
name: Release Checklist Template
about: Checklist of versioning to create a taggable commit for Zebra
title: ''
labels:
assignees: ''
Versioning
How to Increment Versions
Zebra follows semantic versioning. Semantic versions look like: MAJOR
.
MINOR.
PATCH[-
TAG.
PRE-RELEASE]The draft
zebrad
changelog will have an automatic version bump. This version is based on the labels on the PRs in the release.Check that the automatic
zebrad
version increment is correct:If we're releasing a mainnet network upgrade, it is a
major
release:major
version of all the Zebra crates.patch
version 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
minor
release:minor
version ofzebrad
.pre-release
version of the other crates.patch
version of the tower crates.Otherwise, it is a
patch
release:patch
version ofzebrad
.pre-release
version of the other crates.patch
version of the tower crates.Zebra's Rust API is not stable or supported, so we keep all the crates on the same beta
pre-release
version.Version Locations
Once you know which versions you want to increment, you can find them in the:
zebrad (rc):
Cargo.toml
zebra-network
protocol user agent: https://github.com/ZcashFoundation/zebra/blob/main/zebra-network/src/constants.rsREADME.md
book/src/user/docker.md
crates (beta):
Cargo.toml
stower (patch):
Cargo.toml
sauto-generated:
Cargo.lock
: runcargo build
after updating all theCargo.toml
sVersion Tooling
You can use
fastmod
to interactively find and replace versions.For example, you can do something like:
If you use
fastmod
, don't update versions inCHANGELOG.md
orzebra-dependencies-for-audit.md
.README
Update the README to:
Check for changes in the
Dockerfile
since the last tag:git diff <previous-release-tag> docker/Dockerfile
.Cargo.toml
sYou 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
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 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":
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:
(for example:
bump-v1.0.0-rc.0
- this needs to be different to the tag name)&template=release-checklist.md
to the comparing url (Example).Do not unfreeze the whole repository.
main
branch 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.0
main
branchZebra
followed by the version tag,for example:
Zebra 1.0.0-rc.0
starting 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
lightwalletd
tests, 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 (
major
orminor
), or high-priority bug fixes:Release Failures
If building or running fails after tagging:
CHANGELOG.md
with details about the fix