diff --git a/.changelog/unreleased/breaking-changes/90-tendermint-proto-0.31.md b/.changelog/v0.30.0/breaking-changes/90-tendermint-proto-0.31.md similarity index 100% rename from .changelog/unreleased/breaking-changes/90-tendermint-proto-0.31.md rename to .changelog/v0.30.0/breaking-changes/90-tendermint-proto-0.31.md diff --git a/.changelog/unreleased/breaking-changes/10-extern-ics23.md b/.changelog/v0.31.0-alpha.1/breaking-changes/10-extern-ics23.md similarity index 53% rename from .changelog/unreleased/breaking-changes/10-extern-ics23.md rename to .changelog/v0.31.0-alpha.1/breaking-changes/10-extern-ics23.md index 83cc169f..ddedbaeb 100644 --- a/.changelog/unreleased/breaking-changes/10-extern-ics23.md +++ b/.changelog/v0.31.0-alpha.1/breaking-changes/10-extern-ics23.md @@ -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)) diff --git a/.changelog/v0.31.0-alpha.1/summary.md b/.changelog/v0.31.0-alpha.1/summary.md new file mode 100644 index 00000000..610ee320 --- /dev/null +++ b/.changelog/v0.31.0-alpha.1/summary.md @@ -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. diff --git a/CHANGELOG.md b/CHANGELOG.md index 7606afa7..3b0813bb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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* diff --git a/Cargo.toml b/Cargo.toml index 3056c658..ef715b17 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "ibc-proto" -version = "0.30.0" +version = "0.31.0-alpha.1" authors = ["Informal Systems "] edition = "2021" license = "Apache-2.0"