Skip to content

feat: add celestia-node.sh script#1524

Merged
Bidon15 merged 3 commits intomainfrom
jcs/add-celestia-node-script
Apr 15, 2024
Merged

feat: add celestia-node.sh script#1524
Bidon15 merged 3 commits intomainfrom
jcs/add-celestia-node-script

Conversation

@jcstein
Copy link
Copy Markdown
Member

@jcstein jcstein commented Apr 12, 2024

Overview

Resolves #1481

Also modifies celestia-app.sh to name the directories celestia-app-temp and celestia-node-temp, respectively.

Provides a simple way to install a celestia-node:

image

Summary by CodeRabbit

  • Documentation
    • Updated installation paths for the celestia-appd binary, log files, and temporary directories.
    • Added automated download and installation script for Celestia Node binary with detailed instructions.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 12, 2024

Walkthrough

The recent updates involve restructuring the directory and path settings for the celestia-appd binary, logs, and temporary files. Additionally, a new installation script for the Celestia Node has been introduced to automate downloading, verifying, and installing pre-built binaries. These changes aim to enhance user experience by simplifying setup processes.

Changes

Files Change Summary
nodes/celestia-app.md, public/celestia-app.sh Updated binary, log, and temp directory paths reflecting the new installation directory structure.
nodes/celestia-node.md, public/celestia-node.sh Added an automated script for downloading and installing the Celestia Node binary, including OS and architecture checks.

Assessment against linked issues

Objective Addressed Explanation
feat: make a quick install similar to celestia-app (#1481)

Poem

🐇✨
In the burrows of code, where binaries lay,
A rabbit hopped forth, bringing updates today.
With a script in its paws, so sleek and so neat,
Installation's a breeze, oh what a treat!
🌟🚀🐾
Celebrate the code, for it leaps and bounds,
In the digital fields, where progress resounds.


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between b0def0c and 41c1213.
Files selected for processing (2)
  • public/celestia-app.sh (2 hunks)
  • public/celestia-node.sh (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • public/celestia-app.sh
  • public/celestia-node.sh

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 12, 2024

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-04-15 09:34 UTC

@jcstein jcstein requested a review from Bidon15 April 12, 2024 19:28
Copy link
Copy Markdown
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: 1

Actionable comments outside the diff hunks (3)
nodes/celestia-node.md (2)

Line range hint 133-133: Remove the comma before "if" for grammatical correctness.

- First, we recommend [reading the overview](./overview.md) of our node types, if you haven't yet.
+ First, we recommend [reading the overview](./overview.md) of our node types if you haven't yet.

Line range hint 144-144: Capitalize "Refer" correctly in the middle of a sentence.

- If you run into any issues, Refer to the [troubleshooting section](./celestia-node-troubleshooting.md).
+ If you run into any issues, refer to the [troubleshooting section](./celestia-node-troubleshooting.md).
public/celestia-app.sh (1)

Line range hint 33-33: Add error handling for the cd command to ensure the script exits if the directory change fails.

- cd "$TEMP_DIR"
+ cd "$TEMP_DIR" || exit 1

This change ensures that the script does not continue executing in the wrong directory if the cd command fails, which could lead to unexpected behavior.

Comment thread public/celestia-node.sh Outdated
@jcstein jcstein self-assigned this Apr 12, 2024
@jcstein jcstein added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: make a quick install similar to celestia-app

2 participants