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

docs: add changelog for callbacks and 08-wasm #5910

Merged
merged 10 commits into from
Mar 11, 2024

Conversation

crodriguezvega
Copy link
Contributor

@crodriguezvega crodriguezvega commented Feb 28, 2024

Description

I will also backport this to the release lines...

closes: #XXXX

Commit Message / Changelog Entry

type: commit message

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.

  • Targeted PR against the correct branch (see CONTRIBUTING.md).
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/).
  • Added relevant godoc comments.
  • Provide a commit message to be used for the changelog entry in the PR description for review.
  • Re-reviewed Files changed in the Github PR explorer.
  • Review Codecov Report in the comment section below once CI passes.

Summary by CodeRabbit

  • New Features
    • Introduced an ADR8 implementation for callbacks.
    • Added the VerifyMembershipProof rpc query.
    • Introduced the 08-wasm light client proxy module for wasm clients.
  • Bug Fixes
    • Improved error handling in callbacks.

Copy link
Member

@damiannolan damiannolan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙏🏻

Copy link
Member

@srdtrk srdtrk left a 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"?

@crodriguezvega
Copy link
Contributor Author

Are all v0.x versions considered "Unreleased"?

I was not considering them Unreleased, do you think we should?

Copy link
Contributor

coderabbitai bot commented Mar 5, 2024

Walkthrough

The 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 VerifyMembershipProof rpc query are notable. Moreover, the inclusion of the 08-wasm light client proxy module for wasm clients signifies a significant advancement, ensuring compatibility with both ibc-go v8.0 and v7.3, alongside wasmvm v1.5.

Changes

File Path Change Summary
.../callbacks/CHANGELOG.md - Enhanced error handling in callbacks for v0.2.0+ibc-go-v8.0.
- Introduced ADR8 implementation with v0.1.0+ibc-go-v7.3.
.../08-wasm/CHANGELOG.md - Added VerifyMembershipProof rpc query.
- Introduced 08-wasm light client proxy module with releases v0.1.0+ibc-go-v8.0-wasmvm-v1.5 and v0.1.0+ibc-go-v7.3-wasmvm-v1.5.

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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Commits Files that changed from the base of the PR and between 511236b and e84c821.
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 and v0.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.

modules/apps/callbacks/CHANGELOG.md Outdated Show resolved Hide resolved
modules/apps/callbacks/CHANGELOG.md Outdated Show resolved Hide resolved
modules/light-clients/08-wasm/CHANGELOG.md Outdated Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

Commits Files that changed from the base of the PR and between e84c821 and 5b1fbfd.
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

Copy link
Contributor

@DimitrisJim DimitrisJim left a 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 @@
<!--
Copy link
Contributor

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?

Copy link

sonarcloud bot commented Mar 7, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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: 2

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 5b1fbfd and 84da8c1.
Files selected for processing (1)
  • modules/apps/callbacks/CHANGELOG.md (1 hunks)


### 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.
Copy link
Contributor

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.
Copy link
Contributor

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.

Suggested change
* [\#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.

@crodriguezvega crodriguezvega merged commit 44a7254 into main Mar 11, 2024
33 checks passed
@crodriguezvega crodriguezvega deleted the carlos/add-changelog-callbacks-wasm branch March 11, 2024 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants