Skip to content

Commit

Permalink
chore: Release v1.6.0 (#8319)
Browse files Browse the repository at this point in the history
* Prepare the CHANGELOG for v1.6.0

* chore: Release

* Set `ESTIMATED_RELEASE_HEIGHT` to 2_413_000

* Revert "chore: Release"

This reverts commit 5261e85.

* chore: Release

* Fix release-crates-dry-run

* Temporarily turn off bumps for `zebra-{scan,grpc}`

* Apply suggestions from code review

Co-authored-by: Arya <[email protected]>

* Re-enable test bump for `zebra-scan`

* Re-enable test bumps for `zebra-{scan, grpc}`

* Turn off dry-run bumps for `zebra-{scan, grpc}`

* Re-enable bumps and disable dry-run publishing

* Re-enable dry-run publishing

* Exclude `zebra-scan` from publishing

---------

Co-authored-by: Arya <[email protected]>
  • Loading branch information
upbqdn and arya2 authored Feb 23, 2024
1 parent c2cfde0 commit 58bfe97
Show file tree
Hide file tree
Showing 20 changed files with 159 additions and 104 deletions.
8 changes: 5 additions & 3 deletions .github/workflows/scripts/release-crates-dry-run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,11 @@ fi
# with an extra `--no-confirm` argument for non-interactive testing.
# Update everything except for alpha crates and zebrad:
cargo release version --verbose --execute --no-confirm --allow-branch '*' --workspace --exclude zebrad --exclude zebra-scan --exclude zebra-grpc beta

# Due to a bug in cargo-release, we need to pass exact versions for alpha crates:
cargo release version --verbose --execute --allow-branch '*' --package zebra-scan 0.1.0-alpha.4
cargo release version --verbose --execute --allow-branch '*' --package zebra-grpc 0.1.0-alpha.2
cargo release version --verbose --execute --no-confirm --allow-branch '*' --package zebra-scan 0.1.0-alpha.5
cargo release version --verbose --execute --no-confirm --allow-branch '*' --package zebra-grpc 0.1.0-alpha.3

# Update zebrad:
cargo release version --verbose --execute --no-confirm --allow-branch '*' --package zebrad patch
# Continue with the release process:
Expand All @@ -33,6 +35,6 @@ cargo release commit --verbose --execute --no-confirm --allow-branch '*'
# Dry run to check the release
# Workaround for unpublished dependency version errors: https://github.com/crate-ci/cargo-release/issues/691
# TODO: check all crates after fixing these errors
cargo release publish --verbose --dry-run --allow-branch '*' --workspace --exclude zebra-consensus --exclude zebra-utils --exclude zebrad
cargo release publish --verbose --dry-run --allow-branch '*' --workspace --exclude zebra-consensus --exclude zebra-utils --exclude zebrad --exclude zebra-scan

echo "Release process completed."
58 changes: 58 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,64 @@ All notable changes to Zebra are documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org).

## [Zebra 1.6.0](https://github.com/ZcashFoundation/zebra/releases/tag/v1.6.0) - 2024-02-23

This release exposes the shielded scanning functionality through an initial
version of a gRPC server, documented in the [Zebra
Book](https://zebra.zfnd.org/user/shielded-scan-grpc-server.html).

> [!NOTE]
> Building Zebra now depends on
> [`protoc`](https://github.com/protocolbuffers/protobuf). See the [Build
> Instructions](https://github.com/ZcashFoundation/zebra?tab=readme-ov-file#building-zebra)
> for more details.
### Added

- Add `docker-compose` file to run CI locally ([#8209](https://github.com/ZcashFoundation/zebra/pull/8209))
- Allow users to use Zebra + LWD with persistent states ([#8215](https://github.com/ZcashFoundation/zebra/pull/8215))

#### Scanner

- Add a new `zebra-grpc` crate ([#8167](https://github.com/ZcashFoundation/zebra/pull/8167))
- Start scanner gRPC server with `zebrad` ([#8241](https://github.com/ZcashFoundation/zebra/pull/8241))
- Add gRPC server reflection and document how to use the gRPC server ([#8288](https://github.com/ZcashFoundation/zebra/pull/8288))
- Add the `GetInfo` gRPC method ([#8178](https://github.com/ZcashFoundation/zebra/pull/8178))
- Add the `GetResults` gRPC method ([#8255](https://github.com/ZcashFoundation/zebra/pull/8255))
- Add the `Scan` gRPC method ([#8268](https://github.com/ZcashFoundation/zebra/pull/8268), [#8303](https://github.com/ZcashFoundation/zebra/pull/8303))
- Add the `RegisterKeys` gRPC method ([#8266](https://github.com/ZcashFoundation/zebra/pull/8266))
- Add the `ClearResults` and `DeleteKeys` gRPC methods ([#8237](https://github.com/ZcashFoundation/zebra/pull/8237))
- Add snapshot tests for new gRPCs ([#8277](https://github.com/ZcashFoundation/zebra/pull/8277))
- Add unit tests for new gRPCs ([#8293](https://github.com/ZcashFoundation/zebra/pull/8293))
- Create a tower Service in `zebra-scan` ([#8185](https://github.com/ZcashFoundation/zebra/pull/8185))
- Implement the `SubscribeResults` scan service request ([#8253](https://github.com/ZcashFoundation/zebra/pull/8253))
- Implement the `ClearResults` scan service request ([#8219](https://github.com/ZcashFoundation/zebra/pull/8219))
- Implement the `DeleteKeys` scan service request ([#8217](https://github.com/ZcashFoundation/zebra/pull/8217))
- Implement the `RegisterKeys` scan service request ([#8251](https://github.com/ZcashFoundation/zebra/pull/8251))
- Implement the `Results` scan service request ([#8224](https://github.com/ZcashFoundation/zebra/pull/8224))
- Test the `RegisterKeys` scan service request ([#8281](https://github.com/ZcashFoundation/zebra/pull/8281))
- Add `ViewingKey` type in `zebra-chain` ([#8198](https://github.com/ZcashFoundation/zebra/pull/8198))
- Handle `RegisterKeys` messages in scan task ([#8222](https://github.com/ZcashFoundation/zebra/pull/8222))

### Changed

- Remove `rfc.md` file ([#8228](https://github.com/ZcashFoundation/zebra/pull/8228))
- Update Debian from Bullseye to Bookworm in Docker ([#8273](https://github.com/ZcashFoundation/zebra/pull/8273))
- Remove Zebra RFCs from `CONTRIBUTING.md` ([#8304](https://github.com/ZcashFoundation/zebra/pull/8304))
- Publish fewer tags in Docker Hub ([#8300](https://github.com/ZcashFoundation/zebra/pull/8300))
- Add Zebra crate versions to dev-dependencies and remove circular dev-dependencies ([#8171](https://github.com/ZcashFoundation/zebra/pull/8171))
- Update docs for building Zebra ([#8315](https://github.com/ZcashFoundation/zebra/pull/8315))

### Fixed

- Set log rotation to avoid docker bugs ([#8269](https://github.com/ZcashFoundation/zebra/pull/8269))
- Improve error message in `non_blocking_logger` test ([#8276](https://github.com/ZcashFoundation/zebra/pull/8276))

### Contributors

Thank you to everyone who contributed to this release, we couldn't make Zebra without you:
@arya2, @bishopcheckmate, @chairulakmal, @gustavovalverde, @mpguerra, @oxarbitrage and @upbqdn.

## [Zebra 1.5.2](https://github.com/ZcashFoundation/zebra/releases/tag/v1.5.2) - 2024-01-23

This release serves as a hotfix for version 1.5.1, addressing issues encountered after its initial release. For more information about version 1.5.1, refer to [this link](https://github.com/ZcashFoundation/zebra/releases/tag/v1.5.2).
Expand Down
28 changes: 14 additions & 14 deletions Cargo.lock
Original file line number Diff line number Diff line change
Expand Up @@ -4684,7 +4684,7 @@ dependencies = [

[[package]]
name = "tower-batch-control"
version = "0.2.41-beta.10"
version = "0.2.41-beta.11"
dependencies = [
"color-eyre",
"ed25519-zebra",
Expand All @@ -4707,7 +4707,7 @@ dependencies = [

[[package]]
name = "tower-fallback"
version = "0.2.41-beta.10"
version = "0.2.41-beta.11"
dependencies = [
"futures-core",
"pin-project",
Expand Down Expand Up @@ -5691,7 +5691,7 @@ dependencies = [

[[package]]
name = "zebra-chain"
version = "1.0.0-beta.34"
version = "1.0.0-beta.35"
dependencies = [
"bitflags 2.4.2",
"bitflags-serde-legacy",
Expand Down Expand Up @@ -5753,7 +5753,7 @@ dependencies = [

[[package]]
name = "zebra-consensus"
version = "1.0.0-beta.34"
version = "1.0.0-beta.35"
dependencies = [
"bellman",
"blake2b_simd",
Expand Down Expand Up @@ -5799,7 +5799,7 @@ dependencies = [

[[package]]
name = "zebra-grpc"
version = "0.1.0-alpha.1"
version = "0.1.0-alpha.2"
dependencies = [
"color-eyre",
"futures-util",
Expand All @@ -5821,7 +5821,7 @@ dependencies = [

[[package]]
name = "zebra-network"
version = "1.0.0-beta.34"
version = "1.0.0-beta.35"
dependencies = [
"bitflags 2.4.2",
"byteorder",
Expand Down Expand Up @@ -5862,7 +5862,7 @@ dependencies = [

[[package]]
name = "zebra-node-services"
version = "1.0.0-beta.34"
version = "1.0.0-beta.35"
dependencies = [
"color-eyre",
"jsonrpc-core",
Expand All @@ -5875,7 +5875,7 @@ dependencies = [

[[package]]
name = "zebra-rpc"
version = "1.0.0-beta.34"
version = "1.0.0-beta.35"
dependencies = [
"chrono",
"futures",
Expand Down Expand Up @@ -5906,7 +5906,7 @@ dependencies = [

[[package]]
name = "zebra-scan"
version = "0.1.0-alpha.3"
version = "0.1.0-alpha.4"
dependencies = [
"bls12_381",
"chrono",
Expand Down Expand Up @@ -5938,7 +5938,7 @@ dependencies = [

[[package]]
name = "zebra-script"
version = "1.0.0-beta.34"
version = "1.0.0-beta.35"
dependencies = [
"displaydoc",
"hex",
Expand All @@ -5951,7 +5951,7 @@ dependencies = [

[[package]]
name = "zebra-state"
version = "1.0.0-beta.34"
version = "1.0.0-beta.35"
dependencies = [
"bincode",
"chrono",
Expand Down Expand Up @@ -5995,7 +5995,7 @@ dependencies = [

[[package]]
name = "zebra-test"
version = "1.0.0-beta.34"
version = "1.0.0-beta.35"
dependencies = [
"color-eyre",
"futures",
Expand Down Expand Up @@ -6023,7 +6023,7 @@ dependencies = [

[[package]]
name = "zebra-utils"
version = "1.0.0-beta.34"
version = "1.0.0-beta.35"
dependencies = [
"color-eyre",
"hex",
Expand All @@ -6048,7 +6048,7 @@ dependencies = [

[[package]]
name = "zebrad"
version = "1.5.2"
version = "1.6.0"
dependencies = [
"abscissa_core",
"atty",
Expand Down
2 changes: 1 addition & 1 deletion book/src/user/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ docker run -d --platform linux/amd64 \
### Build it locally

```shell
git clone --depth 1 --branch v1.5.2 https://github.com/ZcashFoundation/zebra.git
git clone --depth 1 --branch v1.6.0 https://github.com/ZcashFoundation/zebra.git
docker build --file docker/Dockerfile --target runtime --tag zebra:local .
docker run --detach zebra:local
```
Expand Down
4 changes: 2 additions & 2 deletions book/src/user/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To compile Zebra directly from GitHub, or from a GitHub release source archive:
```sh
git clone https://github.com/ZcashFoundation/zebra.git
cd zebra
git checkout v1.5.2
git checkout v1.6.0
```

3. Build and Run `zebrad`
Expand All @@ -32,7 +32,7 @@ target/release/zebrad start
### Compiling from git using cargo install

```sh
cargo install --git https://github.com/ZcashFoundation/zebra --tag v1.5.2 zebrad
cargo install --git https://github.com/ZcashFoundation/zebra --tag v1.6.0 zebrad
```

### Compiling on ARM
Expand Down
11 changes: 4 additions & 7 deletions tower-batch-control/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
[package]
name = "tower-batch-control"
version = "0.2.41-beta.10"
authors = [
"Zcash Foundation <[email protected]>",
"Tower Maintainers <[email protected]>",
]
version = "0.2.41-beta.11"
authors = ["Zcash Foundation <[email protected]>", "Tower Maintainers <[email protected]>"]
description = "Tower middleware for batch request processing"
# # Legal
#
Expand Down Expand Up @@ -46,7 +43,7 @@ rand = "0.8.5"

tokio = { version = "1.36.0", features = ["full", "tracing", "test-util"] }
tokio-test = "0.4.3"
tower-fallback = { path = "../tower-fallback/", version = "0.2.41-beta.10" }
tower-fallback = { path = "../tower-fallback/", version = "0.2.41-beta.11" }
tower-test = "0.4.0"

zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.34" }
zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.35" }
4 changes: 2 additions & 2 deletions tower-fallback/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "tower-fallback"
version = "0.2.41-beta.10"
version = "0.2.41-beta.11"
authors = ["Zcash Foundation <[email protected]>"]
description = "A Tower service combinator that sends requests to a first service, then retries processing on a second fallback service if the first service errors."
license = "MIT OR Apache-2.0"
Expand All @@ -24,4 +24,4 @@ tracing = "0.1.39"
[dev-dependencies]
tokio = { version = "1.36.0", features = ["full", "tracing", "test-util"] }

zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.34" }
zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.35" }
6 changes: 3 additions & 3 deletions zebra-chain/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "zebra-chain"
version = "1.0.0-beta.34"
version = "1.0.0-beta.35"
authors = ["Zcash Foundation <[email protected]>"]
description = "Core Zcash data structures"
license = "MIT OR Apache-2.0"
Expand Down Expand Up @@ -145,7 +145,7 @@ proptest-derive = { version = "0.4.0", optional = true }
rand = { version = "0.8.5", optional = true }
rand_chacha = { version = "0.3.1", optional = true }

zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.34", optional = true }
zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.35", optional = true }

[dev-dependencies]
# Benchmarks
Expand All @@ -168,7 +168,7 @@ rand_chacha = "0.3.1"

tokio = { version = "1.36.0", features = ["full", "tracing", "test-util"] }

zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.34" }
zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.35" }

[[bench]]
name = "block"
Expand Down
20 changes: 10 additions & 10 deletions zebra-consensus/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "zebra-consensus"
version = "1.0.0-beta.34"
version = "1.0.0-beta.35"
authors = ["Zcash Foundation <[email protected]>"]
description = "Implementation of Zcash consensus checks"
license = "MIT OR Apache-2.0"
Expand Down Expand Up @@ -63,13 +63,13 @@ orchard = "0.6.0"
zcash_proofs = { version = "0.13.0-rc.1", features = ["multicore" ] }
wagyu-zcash-parameters = "0.2.0"

tower-fallback = { path = "../tower-fallback/", version = "0.2.41-beta.10" }
tower-batch-control = { path = "../tower-batch-control/", version = "0.2.41-beta.10" }
tower-fallback = { path = "../tower-fallback/", version = "0.2.41-beta.11" }
tower-batch-control = { path = "../tower-batch-control/", version = "0.2.41-beta.11" }

zebra-script = { path = "../zebra-script", version = "1.0.0-beta.34" }
zebra-state = { path = "../zebra-state", version = "1.0.0-beta.34" }
zebra-node-services = { path = "../zebra-node-services", version = "1.0.0-beta.34" }
zebra-chain = { path = "../zebra-chain", version = "1.0.0-beta.34" }
zebra-script = { path = "../zebra-script", version = "1.0.0-beta.35" }
zebra-state = { path = "../zebra-state", version = "1.0.0-beta.35" }
zebra-node-services = { path = "../zebra-node-services", version = "1.0.0-beta.35" }
zebra-chain = { path = "../zebra-chain", version = "1.0.0-beta.35" }

# prod feature progress-bar
howudoin = { version = "0.1.2", optional = true }
Expand All @@ -94,6 +94,6 @@ tokio = { version = "1.36.0", features = ["full", "tracing", "test-util"] }
tracing-error = "0.2.0"
tracing-subscriber = "0.3.18"

zebra-state = { path = "../zebra-state", version = "1.0.0-beta.34", features = ["proptest-impl"] }
zebra-chain = { path = "../zebra-chain", version = "1.0.0-beta.34", features = ["proptest-impl"] }
zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.34" }
zebra-state = { path = "../zebra-state", version = "1.0.0-beta.35", features = ["proptest-impl"] }
zebra-chain = { path = "../zebra-chain", version = "1.0.0-beta.35", features = ["proptest-impl"] }
zebra-test = { path = "../zebra-test/", version = "1.0.0-beta.35" }
6 changes: 3 additions & 3 deletions zebra-grpc/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "zebra-grpc"
version = "0.1.0-alpha.1"
version = "0.1.0-alpha.2"
authors = ["Zcash Foundation <[email protected]>"]
description = "Zebra gRPC interface"
license = "MIT OR Apache-2.0"
Expand Down Expand Up @@ -28,8 +28,8 @@ color-eyre = "0.6.2"

zcash_primitives = { version = "0.13.0-rc.1" }

zebra-node-services = { path = "../zebra-node-services", version = "1.0.0-beta.34", features = ["shielded-scan"] }
zebra-chain = { path = "../zebra-chain" , version = "1.0.0-beta.34" }
zebra-node-services = { path = "../zebra-node-services", version = "1.0.0-beta.35", features = ["shielded-scan"] }
zebra-chain = { path = "../zebra-chain" , version = "1.0.0-beta.35" }

[build-dependencies]
tonic-build = "0.11.0"
Expand Down
4 changes: 2 additions & 2 deletions zebra-network/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "zebra-network"
version = "1.0.0-beta.34"
version = "1.0.0-beta.35"
authors = ["Zcash Foundation <[email protected]>", "Tower Maintainers <[email protected]>"]
description = "Networking code for Zebra"
# # Legal
Expand Down Expand Up @@ -83,7 +83,7 @@ howudoin = { version = "0.1.2", optional = true }
proptest = { version = "1.4.0", optional = true }
proptest-derive = { version = "0.4.0", optional = true }

zebra-chain = { path = "../zebra-chain", version = "1.0.0-beta.34", features = ["async-error"] }
zebra-chain = { path = "../zebra-chain", version = "1.0.0-beta.35", features = ["async-error"] }

[dev-dependencies]
proptest = "1.4.0"
Expand Down
4 changes: 2 additions & 2 deletions zebra-node-services/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "zebra-node-services"
version = "1.0.0-beta.34"
version = "1.0.0-beta.35"
authors = ["Zcash Foundation <[email protected]>"]
description = "The interfaces of some Zebra node services"
license = "MIT OR Apache-2.0"
Expand Down Expand Up @@ -37,7 +37,7 @@ rpc-client = [
shielded-scan = ["tokio"]

[dependencies]
zebra-chain = { path = "../zebra-chain" , version = "1.0.0-beta.34" }
zebra-chain = { path = "../zebra-chain" , version = "1.0.0-beta.35" }

# Optional dependencies

Expand Down
Loading

0 comments on commit 58bfe97

Please sign in to comment.