Skip to content

Commit

Permalink
Prepare release for v0.31.0 (#105)
Browse files Browse the repository at this point in the history
  • Loading branch information
romac authored May 31, 2023
1 parent 5b8f381 commit ead3ee9
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 12 deletions.
7 changes: 7 additions & 0 deletions .changelog/v0.31.0-alpha.1/95-pbjson.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
- Derive `Serialize` and `Deserialize` impls compatible with ProtoJSON using
`pbjson-build`.

This is a breaking change because the code generated by `pbjson-build` is not
`no_std` compatible. Therefore, the `serde` annotations on the generated protos
are only enabled when the `std` feature of `ibc-proto` is enabled.
([\#95](https://github.com/cosmos/ibc-proto-rs/issues/95))
11 changes: 11 additions & 0 deletions .changelog/v0.31.0/summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
*May 31st, 2023*

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

There are no changes from v0.31.0-alpha.2.

For the differences since v0.30.0, please see the changelog entries for v0.31.0-alpha.1 and v0.31.0-alpha.1.

> **Warning**
> This release removes support for `Serialize` and `Deserailize` trait impls being available in `no_std` context.
> See the release notes below and associated issues for more details.
32 changes: 21 additions & 11 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# CHANGELOG

## v0.31.0

*May 31st, 2023*

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

There are no changes from v0.31.0-alpha.2.

For the differences since v0.30.0, please see the changelog entries for v0.31.0-alpha.1 and v0.31.0-alpha.1.

> **Warning**
> This release removes support for `Serialize` and `Deserailize` trait impls being available in `no_std` context.
> See the release notes below and associated issues for more details.
## v0.31.0-alpha.2

*May 3rd, 2023*
Expand All @@ -8,10 +22,6 @@ This is the second alpha release of `ibc-proto` v0.31.0.

It only updates the `tendermint-proto` version to v0.32.0.

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

- Update `tendermint-proto` to v0.32.0
Expand All @@ -30,21 +40,21 @@ This is nonetheless a breaking change as it may break compilation or trigger war

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 the 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
This is 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))

- Derive `Serialize` and `Deserialize` impls compatible with ProtoJSON using `pbjson-build`.
This is a breaking change because the code generated by `pbjson-build` is not
`no_std` compatible. Therefore, the `serde` annotations on the generated protos
are only enabled when the `std` feature of `ibc-proto` is enabled.
([\#95](https://github.com/cosmos/ibc-proto-rs/issues/95))

## 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.31.0-alpha.2"
version = "0.31.0"
authors = ["Informal Systems <[email protected]>"]
edition = "2021"
license = "Apache-2.0"
Expand Down

0 comments on commit ead3ee9

Please sign in to comment.