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: clarify no cosmovisor #1663

Merged
merged 1 commit into from
Aug 5, 2024
Merged

Conversation

rootulp
Copy link
Contributor

@rootulp rootulp commented Aug 5, 2024

Closes #1661

Summary by CodeRabbit

  • Documentation
    • Updated the hardfork process documentation to clarify upgrade requirements for consensus node and validator operators, specifying that Cosmovisor is not required for binary upgrades.

@rootulp rootulp self-assigned this Aug 5, 2024
@rootulp rootulp marked this pull request as ready for review August 5, 2024 17:49
Copy link
Contributor

coderabbitai bot commented Aug 5, 2024

Walkthrough

The updates clarify the upgrade requirements for consensus node or validator operators during the Lemongrass hardfork. Notably, operators are informed that using Cosmovisor is not necessary for upgrading the binary at the designated height. This change enhances the guidance for node operators, emphasizing the importance of downloading and running the correct binary while simplifying the upgrade process.

Changes

Files Change Summary
nodes/hardfork-process.md Clarified that Cosmovisor is not required for upgrading at the upgrade height, enhancing guidance for operators.

Assessment against linked issues

Objective Addressed Explanation
Don't use Cosmovisor (1661)
Provide upgrade information for celestia-app v2 (1638) No details on celestia-app v2 upgrade provided.

Possibly related issues

  • Info on lemongrass hard-fork #1638: The documentation update does not include essential details about what is included in celestia-app v2.0.0, which would benefit operators.

🐰 In the garden of code, we make our way,
No need for Cosmovisor, just seize the day!
With binary in hand, hop forth with glee,
Lemongrass blooms bright, as we upgrade with ease! 🌱✨


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 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 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: 0

Outside diff range, codebase verification and nitpick comments (1)
nodes/hardfork-process.md (1)

43-43: Consider simplifying the phrase "prior to".

The phrase "prior to" might be wordy. Consider using "before" instead for conciseness.

-  prior to the `--v2-upgrade-height` to remain on the canonical chain.
+  before the `--v2-upgrade-height` to remain on the canonical chain.
Tools
LanguageTool

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

(EN_WORDINESS_PREMIUM_PRIOR_TO)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 86fb976 and 5649143.

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

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

(EN_WORDINESS_PREMIUM_PRIOR_TO)

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.

docs: don't use Cosmovisor
2 participants