-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Prepare release for v0.31.0-alpha.1 (#96)
- Loading branch information
Showing
5 changed files
with
45 additions
and
2 deletions.
There are no files selected for viewing
File renamed without changes.
5 changes: 4 additions & 1 deletion
5
...eased/breaking-changes/10-extern-ics23.md → ...pha.1/breaking-changes/10-extern-ics23.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters