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: warning for cosmovisor #1722

Merged
merged 1 commit into from
Sep 19, 2024
Merged

docs: warning for cosmovisor #1722

merged 1 commit into from
Sep 19, 2024

Conversation

rootulp
Copy link
Contributor

@rootulp rootulp commented Sep 18, 2024

Closes #1720

Screenshot

Screenshot 2024-09-18 at 12 12 14 PM

Summary by CodeRabbit

  • Documentation
    • Clarified requirements for consensus node and validator operators regarding the Lemongrass network upgrade.
    • Removed instructions for using the cosmovisor tool and emphasized the need to upgrade binaries before the specified height.

@rootulp rootulp requested a review from jcstein September 18, 2024 16:12
@rootulp rootulp self-assigned this Sep 18, 2024
Copy link
Contributor

coderabbitai bot commented Sep 18, 2024

Walkthrough

The changes in this pull request focus on clarifying the requirements for consensus node and validator operators during the Lemongrass network upgrade. Key updates include the necessity for operators to download and run a compatible celestia-app binary version 2.0.0 or higher before a specified upgrade height. The previous instruction regarding the use of the cosmovisor tool has been removed, along with a warning that operators should upgrade their binaries several blocks prior to the upgrade height.

Changes

File Change Summary
nodes/network-upgrade-process.md Clarified requirements for operators regarding celestia-app version and removed cosmovisor instructions. Added warning about upgrading binaries before the upgrade height.

Assessment against linked issues

Objective Addressed Explanation
Emphasize that node operators should not use cosmovisor (#1720)

Possibly related issues

  • Info on lemongrass hard-fork #1638: The changes address the need for clear instructions regarding the requirements for the celestia-app version, which is relevant to the objectives of this issue.

Possibly related PRs

Poem

🐇 In the garden where upgrades bloom,
A warning now clears the room.
No cosmovisor, just a new app,
Download it early, take a quick nap!
Lemongrass shines bright and true,
For all the operators, here's to you! 🌱


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9510b6d and 5d5f0db.

Files selected for processing (1)
  • nodes/network-upgrade-process.md (1 hunks)
Additional context used
LanguageTool
nodes/network-upgrade-process.md

[style] ~45-~45: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...and run a celestia-app binary >= v2.0.0 prior to the --v2-upgrade-height to remain on ...

(EN_WORDINESS_PREMIUM_PRIOR_TO)


[style] ~46-~46: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...ble celestia-node binary >= v0.16.0-rc0 prior to the upgrade height. Network | Cha...

(EN_WORDINESS_PREMIUM_PRIOR_TO)

Additional comments not posted (2)
nodes/network-upgrade-process.md (2)

45-45: LGTM!

The instruction is clear and aligns with the PR objective of providing specific guidance to node operators.

The use of 'prior to' is appropriate in this context and does not significantly impact readability. No change is needed.

Tools
LanguageTool

[style] ~45-~45: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...and run a celestia-app binary >= v2.0.0 prior to the --v2-upgrade-height to remain on ...

(EN_WORDINESS_PREMIUM_PRIOR_TO)


54-58: Excellent addition! This warning box perfectly addresses the objectives.

The changes made in this warning box are spot-on and fully align with the PR objectives and the linked issue (#1720). Key points:

  1. The warning box format effectively draws attention to the critical information, ensuring node operators don't miss it.
  2. The clear statement that cosmovisor is not needed for upgrading at the specified height directly addresses the concern raised in the linked issue.
  3. The advice to upgrade binaries several blocks before the upgrade height provides actionable guidance to node operators.

Great work in enhancing the clarity and prominence of this important information for node operators!


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>, please review it.
    -- 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 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.

@jcstein
Copy link
Member

jcstein commented Sep 19, 2024

LGTM thank you for making the PR!

@jcstein jcstein merged commit 98a8d56 into celestiaorg:main Sep 19, 2024
2 of 3 checks passed
@rootulp rootulp deleted the rp/warning branch September 20, 2024 14:27
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.

Emphasize that node operators should not use cosmovisor
2 participants