-
Notifications
You must be signed in to change notification settings - Fork 614
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
docs: add changelog for callbacks and 08-wasm #5910
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🙏🏻
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are all v0.x
versions considered "Unreleased"?
I was not considering them |
WalkthroughThe recent updates encompass improvements in error handling for callbacks and the introduction of new features across modules. Specifically, an ADR8 implementation for callbacks and the addition of the Changes
Related issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review Status
Actionable comments generated: 3
Configuration used: CodeRabbit UI
Files selected for processing (2)
- modules/apps/callbacks/CHANGELOG.md (1 hunks)
- modules/light-clients/08-wasm/CHANGELOG.md (1 hunks)
Additional comments: 1
modules/light-clients/08-wasm/CHANGELOG.md (1)
- 54-65: The release tags for the versions
v0.1.0+ibc-go-v8.0-wasmvm-v1.5
andv0.1.0+ibc-go-v7.3-wasmvm-v1.5
seem to be swapped. The tag URLs suggest that the version numbers in the text might be incorrect, as they do not align with the URLs provided.Please verify the correct version numbers and update the changelog accordingly. This might require checking the release tags on GitHub to ensure accuracy.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (2)
- modules/apps/callbacks/CHANGELOG.md (1 hunks)
- modules/light-clients/08-wasm/CHANGELOG.md (1 hunks)
Files skipped from review as they are similar to previous changes (2)
- modules/apps/callbacks/CHANGELOG.md
- modules/light-clients/08-wasm/CHANGELOG.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was not considering them Unreleased, do you think we should?
We shouldn't because we have released them 😅? 0.x.y release should just mean 'API and state machine changes could occur at this release', i.e new releases do not offer guarantees w.r.t previous releases.
At least, that's how I've thought of it but could be missing something!
@@ -0,0 +1,65 @@ | |||
<!-- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we add this preamble for callbacks too?
Quality Gate passedIssues Measures |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
||
### Bug Fixes | ||
|
||
* [\#4568](https://github.com/cosmos/ibc-go/pull/4568) Include error in event that is emitted when the callback cannot be executed due to a panic or an out of gas error. Packet is only sent if the `IBCSendPacketCallback` returns nil explicitly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a possible spelling mistake in the description of the bug fix for version v0.2.0+ibc-go-v8.0
. The term "f gas error" might be a typo. If it's intended to refer to an "out of gas error," please ensure clarity and correctness in the terminology used.
|
||
### Features | ||
|
||
* [\#3939](https://github.com/cosmos/ibc-go/pull/3939) feat(callbacks): ADR8 implementation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It appears that a white space is missing after "feat(callbacks):" in the feature description for version v0.1.0+ibc-go-v7.3
. For consistency with markdown formatting and readability, consider adding a space after the colon.
- feat(callbacks): ADR8 implementation.
+ feat(callbacks): ADR8 implementation.
Note: The suggested change visually appears identical due to the nature of the issue (missing whitespace). Please ensure a space is added after the colon in the actual document.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
* [\#3939](https://github.com/cosmos/ibc-go/pull/3939) feat(callbacks): ADR8 implementation. | |
* [\#3939](https://github.com/cosmos/ibc-go/pull/3939) feat(callbacks): ADR8 implementation. |
Description
I will also backport this to the release lines...
closes: #XXXX
Commit Message / Changelog Entry
see the guidelines for commit messages. (view raw markdown for examples)
Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/
) or specification (x/<module>/spec/
).godoc
comments.Files changed
in the Github PR explorer.Codecov Report
in the comment section below once CI passes.Summary by CodeRabbit
VerifyMembershipProof
rpc query.08-wasm light client proxy module for wasm clients
.