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: arabica upgrade height #1666

Merged
merged 6 commits into from
Aug 13, 2024

Conversation

rootulp
Copy link
Contributor

@rootulp rootulp commented Aug 6, 2024

Draft PR. We should coordinate this value with DevOps and @tty47 before merging.

Note the value was sourced from celestiaorg/celestia-app#3761

Summary by CodeRabbit

  • New Features

    • Updated command for starting the application to specify a fixed upgrade height of 1751707, ensuring accurate initialization during upgrades.
  • Documentation

    • Enhanced documentation for the Lemongrass hardfork with clear version requirements for the celestia-app and celestia-node binaries.
    • Added a structured table summarizing upgrade details for various networks, improving clarity for node operators.

@rootulp rootulp requested a review from jcstein August 6, 2024 20:43
@rootulp rootulp self-assigned this Aug 6, 2024
Copy link
Contributor

coderabbitai bot commented Aug 6, 2024

Walkthrough

The recent changes enhance the documentation for the Celestia network's upgrade process, particularly focusing on the Lemongrass hardfork. Key modifications include specifying exact versions for the celestia-app and celestia-node binaries, as well as a fixed upgrade height for commands. These updates clarify the requirements and streamline the upgrade procedure, ensuring that node operators have precise instructions to follow during the transition to version 2.0.0.

Changes

Files Change Summary
nodes/consensus-node.md Command updated to use a fixed upgrade height of 1751707 for starting celestia-appd.
nodes/validator-node.md Command modified similarly to specify the upgrade height 1751707 for celestia-appd.
nodes/hardfork-process.md Detailed version requirements for celestia-app (≥2.0.0) and celestia-node (≥0.16.0-rc0) clarified; added a table for upgrade details across networks.

Possibly related issues

  • Info on lemongrass hard-fork #1638: The changes specify new CLI flags and provide essential information about the upcoming upgrade, directly addressing the need for clarity on the Lemongrass hardfork.

🐇 In a world where upgrades bloom,
A rabbit hops through the room.
With commands now crystal clear,
Upgrading brings us lots of cheer!
Version two is on the way,
Let's celebrate this bright new day! 🌼


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
Member

@jcstein jcstein left a comment

Choose a reason for hiding this comment

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

approving for when it's ready to smorge

@rootulp rootulp requested a review from cmwaters August 9, 2024 14:07
@rootulp rootulp changed the title feat: arabica upgrade height docs: arabica upgrade height Aug 9, 2024
@rootulp
Copy link
Contributor Author

rootulp commented Aug 9, 2024

FYI we likely need to push this date and upgrade height back b/c Arabica validators haven't upgraded yet.

@rootulp
Copy link
Contributor Author

rootulp commented Aug 12, 2024

Pushing this upgrade height back to Monday one week from today.

@rootulp rootulp requested a review from tty47 August 12, 2024 16:18
@rootulp rootulp marked this pull request as ready for review August 13, 2024 14:12
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-44: Consider using a more concise wording.

The phrase "prior to" can be replaced with "before" for improved clarity and conciseness.

-  and run a celestia-app binary >= v2.0.0 prior to the `--v2-upgrade-height` to remain on the canonical chain.
+  and run a celestia-app binary >= v2.0.0 before the `--v2-upgrade-height` to remain on the canonical chain.
-  you will need to download and run a compatible celestia-node binary >= v0.16.0-rc0 prior to the upgrade height.
+  you will need to download and run a compatible celestia-node binary >= v0.16.0-rc0 before the upgrade height.
Tools
LanguageTool

[style] ~43-~43: ‘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] ~44-~44: ‘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)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between daf82a6 and 3ea3d80.

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

[style] ~43-~43: ‘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] ~44-~44: ‘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 (3)
nodes/hardfork-process.md (1)

46-50: Table format and content are clear and accurate.

The table provides a clear overview of the upgrade details for the networks. Ensure that the information is kept up-to-date as changes occur.

nodes/validator-node.md (1)

164-164: Upgrade height specification is clear and accurate.

Replacing the placeholder with a specific value ensures clarity for node operators. Ensure that this value is coordinated with the DevOps team and updated if necessary.

nodes/consensus-node.md (1)

314-314: Upgrade height specification is clear and accurate.

Replacing the placeholder with a specific value ensures clarity for node operators. Ensure that this value is coordinated with the DevOps team and updated if necessary.

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.

2 participants