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

Prepare release for v0.31.0-alpha.1 #96

Merged
merged 1 commit into from
May 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
- Re-export the `ics23.cosmos.v1` Protobuf definitions from the `ics23` crate instead of including them directly in this crate.
The proto definitions are exported both under the `ibc_proto::cosmos::ics23::v1` module and under the `ibc_proto::ics23` module
for backward source compatiblity. This is nonetheless a breaking change as it may break compilation or trigger warnings
in an attempt to preserve backward source compatiblity.
This is nonetheless a breaking change as it may break compilation or trigger warnings
in code which relied on these definitions being different than the ones in `ics23`.
Moreover, because the code generated by `pbjson-build` is not `no_std` compatible, the serde annotations
on the generated protos are only enabled when the `std` feature of `ibc-proto` is enabled.
([\#10](https://github.com/cosmos/ibc-proto-rs/issues/10))
12 changes: 12 additions & 0 deletions .changelog/v0.31.0-alpha.1/summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
This is the first alpha release of `ibc-proto` v0.31.0.

The proto definitions for `cosmos.ics23.v1` messages are now re-exported from the [`ics23`](https://crates.io/crates/ics23) crate under both the `ibc_proto::cosmos::ics23::v1` and `ibc_proto::ics23` modules.
The latter will removed in a subsequent release.

This is nonetheless a breaking change as it may break compilation or trigger warnings in code which relied on these definitions being different than the ones in `ics23`.

Moreover, because the code generated by `pbjson-build` is not `no_std` compatible, the serde annotations on the generated protos are only enabled when the `std` feature of `ibc-proto` is enabled.

> **Warning**
> Do no update this alpha release if you are depending on JSON serialization being available in `no_std` context.
> Instead, wait until thee final v0.31.0 release which will restore JSON serialization in `no_std` context.
28 changes: 28 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,33 @@
# CHANGELOG

## v0.31.0-alpha.1

*May 1st, 2023*

This is the first alpha release of `ibc-proto` v0.31.0.

The proto definitions for `cosmos.ics23.v1` messages are now re-exported from the [`ics23`](https://crates.io/crates/ics23) crate under both the `ibc_proto::cosmos::ics23::v1` >
The latter will removed in a subsequent release.

This is nonetheless a breaking change as it may break compilation or trigger warnings in code which relied on these definitions being different than the ones in `ics23`.

Moreover, because the code generated by `pbjson-build` is not `no_std` compatible, the serde annotations on the generated protos are only enabled when the `std` feature of `ibc>

> **Warning**
> Do no update this alpha release if you are depending on JSON serialization being available in `no_std` context.
> Instead, wait until thee final v0.31.0 release which will restore JSON serialization in `no_std` context.

### BREAKING CHANGES

- Re-export the `ics23.cosmos.v1` Protobuf definitions from the `ics23` crate instead of including them directly in this crate.
The proto definitions are exported both under the `ibc_proto::cosmos::ics23::v1` module and under the `ibc_proto::ics23` module
in an attempt to preserve backward source compatiblity.
This is nonetheless a breaking change as it may break compilation or trigger warnings
in code which relied on these definitions being different than the ones in `ics23`.
Moreover, because the code generated by `pbjson-build` is not `no_std` compatible, the serde annotations
on the generated protos are only enabled when the `std` feature of `ibc-proto` is enabled.
([\#10](https://github.com/cosmos/ibc-proto-rs/issues/10))

## v0.30.0

*April 20th, 2023*
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "ibc-proto"
version = "0.30.0"
version = "0.31.0-alpha.1"
authors = ["Informal Systems <[email protected]>"]
edition = "2021"
license = "Apache-2.0"
Expand Down