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

chore: release notes for v26 #8693

Merged
merged 2 commits into from
Sep 12, 2024
Merged

chore: release notes for v26 #8693

merged 2 commits into from
Sep 12, 2024

Conversation

PaddyMc
Copy link
Collaborator

@PaddyMc PaddyMc commented Sep 12, 2024

What is the purpose of the change

Release notes for v26

@PaddyMc PaddyMc added V:state/compatible/backport State machine compatible PR, should be backported A:no-changelog A:backport/v26.x backport patches to v26.x branch labels Sep 12, 2024
Copy link
Contributor

coderabbitai bot commented Sep 12, 2024

Walkthrough

The changes introduce a new upgrade guide for the Osmosis network, detailing the transition from version v25 to v26. It includes essential information about the upgrade proposal, hardware requirements, and instructions for configuring Cosmovisor to automate the upgrade process. The guide provides step-by-step procedures for both automated and manual upgrades, ensuring users have the necessary resources and knowledge for a successful transition.

Changes

File Path Change Summary
networks/osmosis-1/upgrades/v26/mainnet/guide.md Added comprehensive upgrade guide for transitioning from v25 to v26, including Cosmovisor documentation, hardware requirements, and upgrade procedures.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Cosmovisor
    participant System

    User->>System: Initiate upgrade process
    System->>Cosmovisor: Configure for upgrade
    Cosmovisor-->>System: Set up environment variables
    Cosmovisor->>System: Monitor block height
    System-->>Cosmovisor: Detect upgrade block
    Cosmovisor->>System: Execute upgrade commands
    System-->>User: Upgrade completed
Loading

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.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9d103ce and ecc1b2b.

Files ignored due to path filters (1)
  • networks/osmosis-1/upgrades/v26/mainnet/v25_binaries.json is excluded by !**/*.json
Files selected for processing (1)
  • networks/osmosis-1/upgrades/v26/mainnet/guide.md (1 hunks)
Additional comments not posted (2)
networks/osmosis-1/upgrades/v26/mainnet/guide.md (2)

9-34: LGTM!

The hardware requirements and swap space configuration instructions are clear and well-documented.


38-90: LGTM!

The Cosmovisor configuration instructions for both initial setup and upgrading to v26 are clear and well-documented.

Comment on lines +5 to +7
- **v26 Proposal**: [Proposal Page](https://www.mintscan.io/osmosis/proposals/TODO)
- **v26 Upgrade Block Height**: TODO
- **v26 Upgrade Countdown**: [Block Countdown](https://www.mintscan.io/osmosis/blocks/TODO)
Copy link
Contributor

Choose a reason for hiding this comment

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

Update the proposal page and block height links.

Please ensure to replace the "TODO" placeholders with the correct links for the v26 proposal page and upgrade block height countdown before the guide is published.

Comment on lines +94 to +109
## Manual Upgrade Procedure

Follow these steps if you opt for a manual upgrade:

1. Monitor Osmosis until it reaches the specified upgrade block height: TODO.
2. Observe for a panic message followed by continuous peer logs, then halt the daemon.
3. Perform these steps:

```sh
cd $HOME/osmosis
git pull
git checkout v26.0.0
make install
```

4. Restart the Osmosis daemon and observe the upgrade.
Copy link
Contributor

Choose a reason for hiding this comment

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

LGTM, but update the upgrade block height.

The manual upgrade procedure is clear and well-documented. However, please ensure to replace the "TODO" placeholder in step 1 with the correct upgrade block height before the guide is published.

@PaddyMc PaddyMc merged commit 543b131 into main Sep 12, 2024
1 check passed
@PaddyMc PaddyMc deleted the chore/release-notes-v26 branch September 12, 2024 15:34
mergify bot pushed a commit that referenced this pull request Sep 12, 2024
* chore: release notes for v26

* chore: release notes for v26 rename binary json file

(cherry picked from commit 543b131)
PaddyMc added a commit that referenced this pull request Sep 12, 2024
* chore: release notes for v26

* chore: release notes for v26 rename binary json file

(cherry picked from commit 543b131)

Co-authored-by: PaddyMc <paddymchale@hotmail.com>
@coderabbitai coderabbitai bot mentioned this pull request Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:backport/v26.x backport patches to v26.x branch A:no-changelog V:state/compatible/backport State machine compatible PR, should be backported
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants