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: added a version matrix to callbacks and 08-wasm #6339

Merged
merged 6 commits into from
May 21, 2024

Conversation

srdtrk
Copy link
Member

@srdtrk srdtrk commented May 20, 2024

Description

closes: #6337


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.

Summary by CodeRabbit

  • Documentation
    • Enhanced documentation for importing the 08-wasm module, providing compatibility details with ibc-go and wasmvm.
    • Updated instructions on importing the callbacks middleware for compatibility with ibc-go in the integration.md file.

@srdtrk srdtrk added the docs Improvements or additions to documentation label May 20, 2024
Copy link
Contributor

coderabbitai bot commented May 20, 2024

Walkthrough

Walkthrough

The recent updates introduce the Callbacks Middleware and the 08-wasm module. The Callbacks Middleware enables secondary applications to register callbacks for lifecycle events of packets in underlying IBC applications. The 08-wasm module supports running light clients written in Wasm-compilable languages, facilitating the execution of CosmWasm smart contracts within a Wasm VM. No alterations to the declarations of exported or public entities were made.

Changes

File Path Change Summary
modules/apps/callbacks/README.md Introduced the Callbacks Middleware for registering callbacks for lifecycle events in IBC applications.
modules/light-clients/08-wasm/README.md Introduced the 08-wasm module to support running light clients written in Wasm-compilable languages.
docs/docs/03-light-clients/04-wasm/03-integration.md Provided information on importing the 08-wasm module and compatibility details with other modules.
docs/docs/04-middleware/02-callbacks/02-integration.md Added instructions for importing the callbacks middleware with compatibility details.
docs/versioned_docs/version-v7.5.x/03-light-clients/04-wasm/03-integration.md Expanded guidance on importing 08-wasm module and setting it up in app.go.
docs/versioned_docs/version-v7.5.x/04-middleware/02-callbacks/02-integration.md Added instructions for importing the callbacks middleware with compatibility details.
docs/versioned_docs/version-v8.3.x/03-light-clients/04-wasm/03-integration.md Provided instructions for importing 08-wasm module and setting it up for Cosmos SDK chains.
docs/versioned_docs/version-v8.3.x/04-middleware/02-callbacks/02-integration.md Added instructions for importing the callbacks middleware with compatibility details.

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Add version matrix to our readme files (#6337) The changes introduced the Callbacks Middleware and 08-wasm module but did not include a version matrix.

The primary objective of adding a version matrix to the README files for easy identification of correct git commits was not addressed in the provided changes. The changes focused on introducing new modules and their summaries without including the version matrix as proposed in the linked issue.


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 testing code 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 testing code 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 testing code.
    • @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.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

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.

Actionable comments posted: 1

Out of diff range and nitpick comments (1)
modules/light-clients/08-wasm/README.md (1)

17-19: Consider using "frequently" instead of "in many cases" to vary language use and enhance readability.

Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between b6e7de5 and 9053485.
Files selected for processing (2)
  • modules/apps/callbacks/README.md (1 hunks)
  • modules/light-clients/08-wasm/README.md (1 hunks)
Additional Context Used
LanguageTool (3)
modules/apps/callbacks/README.md (1)

Near line 22: A punctuation mark might be missing here.
Context: ...--------------------------------------:| | v0.2.0+ibc-go-v8.0 | 342c00b...

modules/light-clients/08-wasm/README.md (2)

Near line 9: This word is normally spelled as one.
Context: ...ding support for new light clients is a multi-step, time-consuming process involving on-ch...


Near line 19: The phrase ‘in many cases’ is used quite frequently. Consider using a less frequent alternative to set your writing apart.
Context: ...state machines in other ecosystems are, in many cases, implemented in Rust, and thus there ar...

Path-based Instructions (2)
modules/apps/callbacks/README.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

modules/light-clients/08-wasm/README.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

Additional comments not posted (4)
modules/apps/callbacks/README.md (2)

1-9: The description of the Callbacks Middleware is clear and informative.


11-24: The version matrix is well-structured and provides essential information clearly.

modules/light-clients/08-wasm/README.md (2)

11-15: The motivation section effectively communicates the benefits of the 08-wasm module.


21-35: The version matrix is accurately presented and easy to understand.

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.

commits lgtm. would be fine with directly linking to docs for a less beefy readme but don't mind either way.

Copy link
Contributor

@colin-axner colin-axner left a comment

Choose a reason for hiding this comment

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

Amazing thank you so much!! 🙌

@srdtrk
Copy link
Member Author

srdtrk commented May 21, 2024

Ok, I'll add to the docs as well @DimitrisJim

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.

Actionable comments posted: 9

Outside diff range and nitpick comments (25)
docs/versioned_docs/version-v8.3.x/03-light-clients/04-wasm/03-integration.md (10)

Line range hint 142-142: Improve sentence structure for clarity.

- otherwise unexpected behaviour is likely to happen.
+ otherwise, unexpected behaviour is likely to occur.

Line range hint 143-143: Simplify wording to enhance readability.

- In order to share the Wasm VM instance please follow the guideline below.
+ To share the Wasm VM instance, please follow the guideline below.

Line range hint 225-225: Correct typo in sentence.

- in app.go an pass it
+ in app.go and pass it

Line range hint 270-270: Add missing comma for clarity.

- Currently the only option available is the `WithQueryPlugins` option
+ Currently, the only option available is the `WithQueryPlugins` option

Line range hint 328-328: Simplify sentence to avoid redundancy.

- then it is not necessary to do anything in order to allow the creation of `08-wasm` clients.
+ then no action is necessary to allow the creation of `08-wasm` clients.

Line range hint 328-328: Simplify sentence to enhance clarity.

- then in order to use the `08-wasm` module chains must update the [`AllowedClients` parameter]
+ then to use the `08-wasm` module, chains must update the [`AllowedClients` parameter]

Line range hint 356-356: Add missing comma for grammatical correctness.

- Or alternatively the parameter can be updated via a governance proposal
+ Or, alternatively, the parameter can be updated via a governance proposal

Line range hint 360-360: Add missing comma for grammatical correctness.

- As part of the upgrade migration you must also add the module to the upgrades store
+ As part of the upgrade migration, you must also add the module to the upgrades store

Line range hint 381-381: Simplify sentence to enhance clarity.

- In order to use the `08-wasm` module chains are required to register the `WasmSnapshotter` extension
+ To use the `08-wasm` module, chains are required to register the `WasmSnapshotter` extension

Line range hint 382-382: Add missing comma for grammatical correctness.

- In order to use the `08-wasm` module chains are required to register the `WasmSnapshotter` extension
+ In order to use the `08-wasm` module, chains are required to register the `WasmSnapshotter` extension
docs/docs/03-light-clients/04-wasm/03-integration.md (15)

Line range hint 144-144: Add a comma for clarity.

- When it comes to instantiating `08-wasm`'s keeper there are two recommended ways of doing it.
+ When it comes to instantiating `08-wasm`'s keeper, there are two recommended ways of doing it.

Line range hint 148-148: Separate the adverb "otherwise" with a comma.

- various caches, otherwise unexpected behaviour is likely to happen
+ various caches, otherwise, unexpected behaviour is likely to happen

Line range hint 149-149: Simplify the sentence to avoid wordiness.

- In order to share the Wasm VM instance please follow the guideline below.
+ To share the Wasm VM instance, please follow the guideline below.

Line range hint 150-150: Add a comma after "instance".

- In order to share the Wasm VM instance please follow the guideline below.
+ In order to share the Wasm VM instance, please follow the guideline below.

Line range hint 231-231: Correct the phrase "an pass it".

- instantiating a Wasm VM in app.go an pass it to 08-wasm's
+ instantiating a Wasm VM in app.go and pass it to 08-wasm's

Line range hint 233-233: Add a comma for clarity.

- In the code snippet below we set this field to the `ibc_08-wasm_client_data` folder
+ In the code snippet below, we set this field to the `ibc_08-wasm_client_data` folder

Line range hint 276-276: Add a comma after "Currently".

- Currently the only option available is the `WithQueryPlugins` option
+ Currently, the only option available is the `WithQueryPlugins` option

Line range hint 277-277: Add a comma before "and".

- The use of this API is optional and it is only required if the chain wants
+ The use of this API is optional, and it is only required if the chain wants

Line range hint 298-298: Clarify the use of "accept".

- The `Stargate` querier appends the user defined accept list of query routes to a default list
+ The `Stargate` querier appends the user-defined accept list of query routes to a default list

Line range hint 299-299: Add missing quotation mark.

- `"/ibc.core.client.v1.Query/VerifyMembership"`. This allows for light client smart co...
+ `"/ibc.core.client.v1.Query/VerifyMembership"`. This allows for light client smart contracts...

Line range hint 344-344: Simplify the sentence to avoid wordiness.

- then it is not necessary to do anything in order to allow the creation of `08-wasm` clients.
+ then it is not necessary to do anything to allow the creation of `08-wasm` clients.

Line range hint 344-344: Simplify the sentence to avoid wordiness.

- then in order to use the `08-wasm` module chains must update
+ then to use the `08-wasm` module, chains must update

Line range hint 372-372: Add a comma for clarity.

- Or alternatively the parameter can be updated via a governance proposal
+ Or, alternatively, the parameter can be updated via a governance proposal

Line range hint 397-397: Simplify the sentence to avoid wordiness.

- In order to use the `08-wasm` module chains are required to register the `WasmSnapshotter` extension
+ To use the `08-wasm` module, chains are required to register the `WasmSnapshotter` extension

Line range hint 398-398: Add a comma for clarity.

- In order to use the `08-wasm` module chains are required to register the `WasmSnapshotter` extension
+ To use the `08-wasm` module, chains are required to register the `WasmSnapshotter` extension
Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 9053485 and a55ab58.
Files selected for processing (8)
  • docs/docs/03-light-clients/04-wasm/03-integration.md (1 hunks)
  • docs/docs/04-middleware/02-callbacks/02-integration.md (1 hunks)
  • docs/versioned_docs/version-v7.5.x/03-light-clients/04-wasm/03-integration.md (1 hunks)
  • docs/versioned_docs/version-v7.5.x/04-middleware/02-callbacks/02-integration.md (1 hunks)
  • docs/versioned_docs/version-v8.3.x/03-light-clients/04-wasm/03-integration.md (1 hunks)
  • docs/versioned_docs/version-v8.3.x/04-middleware/02-callbacks/02-integration.md (1 hunks)
  • modules/apps/callbacks/README.md (1 hunks)
  • modules/light-clients/08-wasm/README.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • modules/apps/callbacks/README.md
Additional Context Used
Path-based Instructions (7)
modules/light-clients/08-wasm/README.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

docs/versioned_docs/version-v7.5.x/04-middleware/02-callbacks/02-integration.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

docs/versioned_docs/version-v8.3.x/04-middleware/02-callbacks/02-integration.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

docs/docs/04-middleware/02-callbacks/02-integration.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

docs/versioned_docs/version-v7.5.x/03-light-clients/04-wasm/03-integration.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

docs/versioned_docs/version-v8.3.x/03-light-clients/04-wasm/03-integration.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

docs/docs/03-light-clients/04-wasm/03-integration.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

Additional comments not posted (2)
modules/light-clients/08-wasm/README.md (2)

9-9: Consider correcting the spelling of "multi-step" to "multistep" to enhance the document's professionalism.


23-29: Ensure the version matrix link is functional and leads to the correct document.

Verification successful

The link to the version matrix in the README.md file is functional and leads to the correct document.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the link to the version matrix is correct and functional.

# Test: Check if the link leads to an existing document.
curl -o /dev/null -s -w "%{http_code}\n" https://github.com/cosmos/ibc-go/blob/main/docs/docs/03-light-clients/04-wasm/03-integration.md#importing-the-08-wasm-module

Length of output: 171

Comment on lines +12 to +21
## Importing the `08-wasm` module

`08-wasm` has no stable releases yet. To use it, you need to import the git commit that contains the module with the compatible versions of `ibc-go` and `wasmvm`. To do so, run the following command with the desired git commit in your project:

```sh
go get github.com/cosmos/ibc-go/modules/light-clients/08-wasm@57fcdb9a9a9db9b206f7df2f955866dc4e10fef4
```

You can find the version matrix in [here](../../../../docs/03-light-clients/04-wasm/03-integration.md#importing-the-08-wasm-module).

Copy link
Contributor

Choose a reason for hiding this comment

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

Clarify the version matrix link.

The link provided in line 20 seems to point to the current document itself for the version matrix, which might be confusing. Consider updating it to point directly to the actual version matrix document if it exists elsewhere, or clarify this reference if the matrix is meant to be in the same document.

go get github.com/cosmos/ibc-go/modules/light-clients/08-wasm@57fcdb9a9a9db9b206f7df2f955866dc4e10fef4
```

You can find the version matrix in [here](../../../../docs/03-light-clients/04-wasm/03-integration.md#importing-the-08-wasm-module).
Copy link
Contributor

Choose a reason for hiding this comment

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

Correct grammatical error in setup verb usage.

- setup the `08-wasm` module
+ set up the `08-wasm` module

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
You can find the version matrix in [here](../../../../docs/03-light-clients/04-wasm/03-integration.md#importing-the-08-wasm-module).
You can find the version matrix in [here](../../../../docs/03-light-clients/04-wasm/03-integration.md#importing-the-08-wasm-module).
To integrate the `08-wasm` module, follow the integration points in `app.go` required to set up the `08-wasm` module in a chain binary.

| `v0.1.1+ibc-go-v7.3-wasmvm-v1.5` | 7ee2a2452b79d0bc8316dc622a1243afa058e8cb |
| `v0.1.0+ibc-go-v8.0-wasmvm-v1.5` | 57fcdb9a9a9db9b206f7df2f955866dc4e10fef4 |
| `v0.1.0+ibc-go-v7.3-wasmvm-v1.5` | b306e7a706e1f84a5e11af0540987bd68de9bae5 |

## `app.go` setup

The sample code below shows the relevant integration points in `app.go` required to setup the `08-wasm` module in a chain binary. Since `08-wasm` is a light client module itself, please check out as well the section [Integrating light clients](../../01-ibc/02-integration.md#integrating-light-clients) for more information:
Copy link
Contributor

Choose a reason for hiding this comment

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

Correct verb usage for "setup".

- required to setup the `08-wasm` module
+ required to set up the `08-wasm` module

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
The sample code below shows the relevant integration points in `app.go` required to setup the `08-wasm` module in a chain binary. Since `08-wasm` is a light client module itself, please check out as well the section [Integrating light clients](../../01-ibc/02-integration.md#integrating-light-clients) for more information:
The sample code below shows the relevant integration points in `app.go` required to set up the `08-wasm` module in a chain binary. Since `08-wasm` is a light client module itself, please check out as well the section [Integrating light clients](../../01-ibc/02-integration.md#integrating-light-clients) for more information:


## Overview

Learn about the `08-wasm` light client proxy module.
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove trailing space for cleaner formatting.

- Learn about the `08-wasm` light client proxy module. 
+ Learn about the `08-wasm` light client proxy module.

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
Learn about the `08-wasm` light client proxy module.
Learn about the `08-wasm` light client proxy module.


### Context

Traditionally, light clients used by ibc-go have been implemented only in Go, and since ibc-go v7 (with the release of the 02-client refactor), they are [first-class Cosmos SDK modules](/architecture/adr-010-light-clients-as-sdk-modules). This means that updating existing light client implementations or adding support for new light clients is a multi-step, time-consuming process involving on-chain governance: it is necessary to modify the codebase of ibc-go (if the light client is part of its codebase), re-build chains' binaries, pass a governance proposal and have validators upgrade their nodes.
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove trailing space for cleaner formatting.

- ...re-build chains' binaries, pass a governance proposal and have validators upgrade their nodes. 
+ ...re-build chains' binaries, pass a governance proposal and have validators upgrade their nodes.

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
Traditionally, light clients used by ibc-go have been implemented only in Go, and since ibc-go v7 (with the release of the 02-client refactor), they are [first-class Cosmos SDK modules](/architecture/adr-010-light-clients-as-sdk-modules). This means that updating existing light client implementations or adding support for new light clients is a multi-step, time-consuming process involving on-chain governance: it is necessary to modify the codebase of ibc-go (if the light client is part of its codebase), re-build chains' binaries, pass a governance proposal and have validators upgrade their nodes.
Traditionally, light clients used by ibc-go have been implemented only in Go, and since ibc-go v7 (with the release of the 02-client refactor), they are [first-class Cosmos SDK modules](/architecture/adr-010-light-clients-as-sdk-modules). This means that updating existing light client implementations or adding support for new light clients is a multi-step, time-consuming process involving on-chain governance: it is necessary to modify the codebase of ibc-go (if the light client is part of its codebase), re-build chains' binaries, pass a governance proposal and have validators upgrade their nodes.

Comment on lines +24 to +30
The callbacks middleware has no stable releases yet. To use it, you need to import the git commit that contains the module with the compatible version of `ibc-go`. To do so, run the following command with the desired git commit in your project:

```sh
go get github.com/cosmos/ibc-go/modules/apps/callbacks@17cf1260a9cdc5292512acc9bcf6336ef0d917f4
```

You can find the version matrix in [here](../../../../docs/04-middleware/02-callbacks/02-integration.md#importing-the-callbacks-middleware).
Copy link
Contributor

Choose a reason for hiding this comment

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

Tip

Codebase Verification

The link to the version matrix in the document is incorrect and leads to a 404 error. The correct path should be updated to ensure users can access the version matrix.

  • The current link: ../../../../docs/04-middleware/02-callbacks/02-integration.md#importing-the-callbacks-middleware
  • The correct link should be relative to the root of the repository and point to the same document.

Update the link in the document to:

You can find the version matrix in [here](#importing-the-callbacks-middleware).

This will ensure the link correctly points to the "Importing the callbacks middleware" section within the same document.

Analysis chain

Ensure the version matrix link is functional and leads to the correct document.


The link to the version matrix in the document returns a 404 error, indicating that the document does not exist at the specified location. We need to find the correct path to the version matrix document within the repository and update the link accordingly.


Let's check the content of the identified file docs/versioned_docs/version-v7.5.x/04-middleware/02-callbacks/02-integration.md to verify the presence of the version matrix.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the link to the version matrix is correct and functional.

# Test: Check if the link leads to an existing document.
curl -o /dev/null -s -w "%{http_code}\n" https://github.com/cosmos/ibc-go/blob/main/docs/04-middleware/02-callbacks/02-integration.md#importing-the-callbacks-middleware

Length of output: 174



Script:

#!/bin/bash
# Description: Search for the correct location of the version matrix document within the repository.

# Find the file named '02-integration.md' in the repository.
fd '02-integration.md'

Length of output: 1898



Script:

#!/bin/bash
# Description: Check the content of the identified file to verify the presence of the version matrix.

# Display the content of the identified file.
cat docs/versioned_docs/version-v7.5.x/04-middleware/02-callbacks/02-integration.md

Length of output: 6548

Comment on lines +24 to +30
The callbacks middleware has no stable releases yet. To use it, you need to import the git commit that contains the module with the compatible version of `ibc-go`. To do so, run the following command with the desired git commit in your project:

```sh
go get github.com/cosmos/ibc-go/modules/apps/callbacks@342c00b0f8bd7feeebf0780f208a820b0faf90d1
```

You can find the version matrix in [here](../../../../docs/04-middleware/02-callbacks/02-integration.md#importing-the-callbacks-middleware).
Copy link
Contributor

Choose a reason for hiding this comment

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

Tip

Codebase Verification

The link to the version matrix in the document is broken and returns a 404 error. The correct document and section header do exist within the repository, but the URL in the documentation needs to be updated.

  • The correct path for the document is docs/versioned_docs/version-v8.3.x/04-middleware/02-callbacks/02-integration.md.
  • The section header ## Importing the callbacks middleware is present in this document.

Please update the link in the documentation to point to the correct path.

  • Update the link in docs/versioned_docs/version-v8.3.x/04-middleware/02-callbacks/02-integration.md to ../../../../versioned_docs/version-v8.3.x/04-middleware/02-callbacks/02-integration.md#importing-the-callbacks-middleware.
Analysis chain

Ensure the version matrix link is functional and leads to the correct document.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the link to the version matrix is correct and functional.

# Test: Check if the link leads to an existing document.
curl -o /dev/null -s -w "%{http_code}\n" https://github.com/cosmos/ibc-go/blob/main/docs/04-middleware/02-callbacks/02-integration.md#importing-the-callbacks-middleware

Length of output: 174



Script:

#!/bin/bash
# Locate the document mentioned in the link
fd '02-integration.md'

# Search for the section header within the located document
rg '## Importing the callbacks middleware' $(fd '02-integration.md')

Length of output: 4172

Comment on lines +24 to +30
The callbacks middleware has no stable releases yet. To use it, you need to import the git commit that contains the module with the compatible version of `ibc-go`. To do so, run the following command with the desired git commit in your project:

```sh
go get github.com/cosmos/ibc-go/modules/apps/callbacks@342c00b0f8bd7feeebf0780f208a820b0faf90d1
```

The following table shows the compatibility matrix between the callbacks middleware, `ibc-go`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Tip

Codebase Verification

The link to the version matrix in the documentation is broken, returning a 404 error. The search results indicate that the version matrix is referenced in multiple places but the link is incorrect.

  • The link in docs/docs/04-middleware/02-callbacks/02-integration.md should be updated to point to the correct location of the version matrix.

Please update the link to the version matrix in the documentation to ensure it points to the correct location.

  • File: docs/docs/04-middleware/02-callbacks/02-integration.md
  • Current Link: https://github.com/cosmos/ibc-go/blob/main/docs/04-middleware/02-callbacks/02-integration.md#importing-the-callbacks-middleware
  • Suggested Update: Verify the correct path for the version matrix and update the link accordingly.
Analysis chain

Ensure the version matrix link is functional and leads to the correct document.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the link to the version matrix is correct and functional.

# Test: Check if the link leads to an existing document.
curl -o /dev/null -s -w "%{http_code}\n" https://github.com/cosmos/ibc-go/blob/main/docs/04-middleware/02-callbacks/02-integration.md#importing-the-callbacks-middleware

Length of output: 174



Script:

#!/bin/bash
# Description: Search for the version matrix document in the repository.

# Find all markdown files in the repository
fd --extension md

# Search for the term "version matrix" within the markdown files to locate the correct document
rg "version matrix" --glob "*.md"

Length of output: 31977

Comment on lines +14 to +20
`08-wasm` has no stable releases yet. To use it, you need to import the git commit that contains the module with the compatible versions of `ibc-go` and `wasmvm`. To do so, run the following command with the desired git commit in your project:

```sh
go get github.com/cosmos/ibc-go/modules/light-clients/08-wasm@7ee2a2452b79d0bc8316dc622a1243afa058e8cb
```

You can find the version matrix in [here](../../../../docs/03-light-clients/04-wasm/03-integration.md#importing-the-08-wasm-module).
Copy link
Contributor

Choose a reason for hiding this comment

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

Tip

Codebase Verification

The link to the version matrix in the document points to a non-existent URL, resulting in a 404 error. The correct section heading "Importing the 08-wasm module" exists in the document, but the link needs to be updated to point to the correct path.

  • Update the link in the document to point to the correct section within the same document.
Analysis chain

Ensure the version matrix link is functional and leads to the correct document.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the link to the version matrix is correct and functional.

# Test: Check if the link leads to an existing document.
curl -o /dev/null -s -w "%{http_code}\n" https://github.com/cosmos/ibc-go/blob/main/docs/03-light-clients/04-wasm/03-integration.md#importing-the-08-wasm-module

Length of output: 166



Script:

#!/bin/bash
# Locate the document within the repository
fd '03-integration.md'

# Search for the section within the located document
rg '## Importing the 08-wasm module' $(fd '03-integration.md')

Length of output: 749



Script:

#!/bin/bash
# Search for any headings related to importing the 08-wasm module within the identified documents
rg -i 'importing.*08-wasm' docs/docs/01-ibc/04-middleware/03-integration.md docs/docs/03-light-clients/04-wasm/03-integration.md docs/versioned_docs/version-v7.5.x/03-light-clients/04-wasm/03-integration.md docs/versioned_docs/version-v8.3.x/01-ibc/04-middleware/03-integration.md docs/versioned_docs/version-v8.3.x/03-light-clients/04-wasm/03-integration.md

Length of output: 1093

@srdtrk srdtrk merged commit 074d341 into main May 21, 2024
26 checks passed
@srdtrk srdtrk deleted the serdar/6337-version-matrix-docs branch May 21, 2024 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add version matrix to our readme files
3 participants