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: channel upgrade timeout #5546

Merged

Conversation

charleenfei
Copy link
Contributor

Description

closes: #5268

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.

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.

Thanks @charleenfei 🙏

docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
…f github.com:cosmos/ibc-go into charly/issue#5268-document-how-upgrade-timeout-works
@charleenfei charleenfei added the channel-upgradability Channel upgradability feature label Jan 8, 2024
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.

looks great!

Copy link
Contributor

@crodriguezvega crodriguezvega left a comment

Choose a reason for hiding this comment

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

Nice work, @charleenfei! I think we should mention that height-based timeouts are not supported at the moment.

docs/docs/01-ibc/06-channel-upgrades.md Show resolved Hide resolved
Copy link
Contributor

@chatton chatton left a comment

Choose a reason for hiding this comment

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

LGTM! Just left one suggestion for re-wording

docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
@crodriguezvega crodriguezvega merged commit 681c3da into main Jan 10, 2024
19 checks passed
@crodriguezvega crodriguezvega deleted the charly/issue#5268-document-how-upgrade-timeout-works branch January 10, 2024 10:34
charleenfei added a commit that referenced this pull request Jan 11, 2024
* upgrade timeout docs

* typo

* pr review

* nit: indentation of code in blocks

* Update docs/docs/01-ibc/06-channel-upgrades.md

Co-authored-by: Cian Hatton <cian@interchain.io>

* review comment: add note about upgrading channels CLI

---------

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
Co-authored-by: Cian Hatton <cian@interchain.io>
charleenfei added a commit that referenced this pull request Jan 11, 2024
* upgrade timeout docs

* typo

* pr review

* nit: indentation of code in blocks

* Update docs/docs/01-ibc/06-channel-upgrades.md

Co-authored-by: Cian Hatton <cian@interchain.io>

* review comment: add note about upgrading channels CLI

---------

Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
Co-authored-by: Cian Hatton <cian@interchain.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
channel-upgradability Channel upgradability feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how upgrade timeout works
6 participants