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: Ibcv2 callbacks update #8206

Closed
wants to merge 3 commits into from
Closed

docs: Ibcv2 callbacks update #8206

wants to merge 3 commits into from

Conversation

womensrights
Copy link
Contributor

Description

  • adds warning that ica is only relevant for use with ibc classic
  • updates callbacks integration
  • adds in a ibcv2 specific differences page for v2
  • had to merge the commits with the ibc v2 middleware section so could reference them in the docs

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/).
  • Added relevant godoc comments.
  • Provide a conventional commit message to follow the repository standards.
  • Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
  • Re-reviewed Files changed in the GitHub PR explorer.
  • Review SonarCloud Report in the comment section below once CI passes.

commit 14bc17e
Author: Gjermund Garaba <[email protected]>
Date:   Thu Mar 20 17:20:52 2025 +0100

    chore: add buf push on labels in ci (#8203)

commit 9e8c3db
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Thu Mar 20 14:13:03 2025 +0000

    chore(deps): bump github.com/spf13/viper in /simapp (#8194)

    Bumps [github.com/spf13/viper](https://github.com/spf13/viper) from 1.19.0 to 1.20.0.
    - [Release notes](https://github.com/spf13/viper/releases)
    - [Commits](spf13/viper@v1.19.0...v1.20.0)

    ---
    updated-dependencies:
    - dependency-name: github.com/spf13/viper
      dependency-type: direct:production
      update-type: version-update:semver-minor
    ...

    Signed-off-by: dependabot[bot] <[email protected]>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    Co-authored-by: Gjermund Garaba <[email protected]>

commit a18096e
Author: Susannah Evans <[email protected]>
Date:   Thu Mar 20 15:09:48 2025 +0100

    docs: update ibcv2 middleware docs (#8197)

    * update ibcv2 middleware docs

    * fix dead links

    * improve psuedocode, add security model and design principles section

    * add quick nav

    ---------

    Co-authored-by: Aditya Sripal <[email protected]>

commit aeb5258
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Thu Mar 20 13:24:52 2025 +0100

    chore(deps): bump golangci/golangci-lint-action from 6.5.1 to 6.5.2 (#8196)

    Bumps [golangci/golangci-lint-action](https://github.com/golangci/golangci-lint-action) from 6.5.1 to 6.5.2.
    - [Release notes](https://github.com/golangci/golangci-lint-action/releases)
    - [Commits](golangci/golangci-lint-action@v6.5.1...v6.5.2)

    ---
    updated-dependencies:
    - dependency-name: golangci/golangci-lint-action
      dependency-type: direct:production
      update-type: version-update:semver-patch
    ...

    Signed-off-by: dependabot[bot] <[email protected]>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
    Co-authored-by: Gjermund Garaba <[email protected]>
Copy link
Member

@AdityaSripal AdityaSripal left a comment

Choose a reason for hiding this comment

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

docs/docs/04-middleware/01-callbacks/07-callbacks-IBCv2.md looks fine to me.

I don't understand why you had to merge the previous commits into here and squash them. I think this is why the diffs look so large. Can you just cherry pick the commit you need. Or even simpler just create a new branch off main and copy-paste the new info. In general its best for this PR to only contain the diffs you need

@womensrights
Copy link
Contributor Author

closed in favour of #8216 for callbacks only without squashed commit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants