docs: channel upgrades tutorial

[crodriguezvega]

Description

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.

[srdtrk]

I think we should put this back to draft. I wouldn't want to merge it until I can verify the tutorial works from start to end. This is not possible since hermes v1.9.0 is not yet released

[crodriguezvega]

I think we should put this back to draft. I wouldn't want to merge it until I can verify the tutorial works from start to end. This is not possible since hermes v1.9.0 is not yet released

But, man, it works, trust me bro! It works with the hermes version built from the channel upgradability branch. Even the folks of Atredis doing the audit followed the tutorial and worked for them!

If you feel more comfortable, I can take out the mention of v1.9.0, just say that this has been tested so far with the channel upgradability branch.

I also added this warning:

There is no release of Hermes availabe yet that supports channel upgradability. This tutorial assumes that it will be released in v1.9.0, but the final version might be different. The tutorial will be updated with the release is out.

[srdtrk]

It can stay open then, and I'll review it. We should add a warning in the first page, since people should't find out this tutorial doesn't work at the second/third page. We can merge it if you think there is utility.

[coderabbitai[bot]]

[!WARNING]

Review failed

The head commit changed during the review from 1376549465712bc6473997241bf5dc9b57a5346e to c387b25689b3fa24695c0c33b4dfb60126828ccc.

---

[!TIP]

Early access features: enabled

We are currently testing the following features in early access:

• OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

• You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
• Please join our Discord Community to provide feedback and report issues.
• OSS projects are currently opted into early access features by default.

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

• X
• Mastodon
• Reddit
• LinkedIn

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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @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.