Skip to content

docs: prefer reset-state over unsafe-reset-all - #1697

Merged
jcstein merged 1 commit into
mainfrom
rp/reset-state-only
Sep 5, 2024
Merged

docs: prefer reset-state over unsafe-reset-all#1697
jcstein merged 1 commit into
mainfrom
rp/reset-state-only

Conversation

@rootulp

@rootulp rootulp commented Sep 4, 2024 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Closes #1690

Summary by CodeRabbit

  • New Features
    • Updated error handling instructions for consensus node upgrades, providing a new command for resetting node state.
    • Enhanced documentation for handling synchronization issues after network upgrades, improving user experience and operational procedures.

@rootulp
rootulp requested a review from evan-forbes September 4, 2024 20:29
@rootulp rootulp self-assigned this Sep 4, 2024
@coderabbitai

coderabbitai Bot commented Sep 4, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

The changes involve updating the error handling instructions for consensus node upgrades in the Celestia documentation. The command for resetting the node state has been revised from celestia-appd tendermint unsafe-reset-all to celestia-appd tendermint reset-state. This modification aims to provide clearer and potentially safer guidance for users dealing with synchronization issues following network upgrades.

Changes

Files Change Summary
nodes/consensus-node.md, nodes/validator-node.md Updated the command for resetting the node state from celestia-appd tendermint unsafe-reset-all to celestia-appd tendermint reset-state to improve error handling instructions.

Assessment against linked issues

Objective Addressed Explanation
Explore alternatives to tendermint unsafe-reset-all (#1690) ✅

🐰 In the meadow, I hop with glee,
A new command for all to see!
Reset the node, oh what a treat,
Synchronization now feels so neat!
With reset-state, we dance and play,
Upgrades are smoother, hip-hip-hooray! 🌼

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.

@github-actions

github-actions Bot commented Sep 4, 2024

Copy link
Copy Markdown
Contributor
PR Preview Action v1.4.7
🚀 Deployed preview to https://celestiaorg.github.io/docs-preview/./pr-1697/
on branch main at 2024-09-04 20:29 UTC

coderabbitai[bot]
coderabbitai Bot reviewed Sep 4, 2024
View reviewed changes

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 63c7a56 and ba0c2a3.

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

[uncategorized] ~256-~256: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...etwork has upgraded to a new app version but your consensus node was not prepared fo...

(COMMA_COMPOUND_SENTENCE_2)

nodes/consensus-node.md

[uncategorized] ~436-~436: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...etwork has upgraded to a new app version but your consensus node was not prepared fo...

(COMMA_COMPOUND_SENTENCE_2)

Additional comments not posted (1)
nodes/consensus-node.md (1)

436-436: LGTM!

The code changes are approved. Using celestia-appd tendermint reset-state instead of celestia-appd tendermint unsafe-reset-all is a safer approach for resetting the node state, as it preserves critical files like priv_validator_state.json.

Tools
LanguageTool

[uncategorized] ~436-~436: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...etwork has upgraded to a new app version but your consensus node was not prepared fo...

(COMMA_COMPOUND_SENTENCE_2)

Comment thread nodes/validator-node.md
@rootulp
rootulp requested a review from jcstein September 5, 2024 01:38
jcstein
jcstein approved these changes Sep 5, 2024
View reviewed changes

@jcstein jcstein left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

thank you for making this PR @rootulp. lgtm

@jcstein
jcstein merged commit a68401e into main Sep 5, 2024
@jcstein
jcstein deleted the rp/reset-state-only branch September 5, 2024 14:02
@coderabbitai coderabbitai Bot mentioned this pull request Mar 19, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jcstein jcstein jcstein approved these changes
+2 more reviewers
@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments
@evan-forbes evan-forbes evan-forbes approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@rootulp rootulp

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Explore alternatives to tendermint unsafe-reset-all

3 participants

@rootulp @evan-forbes @jcstein