Skip to content

docs: make app script similar to node #2015

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

Merged
merged 1 commit into from
Apr 28, 2025
Merged

docs: make app script similar to node #2015

merged 1 commit into from
Apr 28, 2025

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Apr 28, 2025

Overview

Summary by CodeRabbit

  • New Features

    • Enhanced installation process with options to install the binary in the Go bin directory (if Go is installed), system bin directory, or keep it in the current directory.
    • Added automatic detection of Go installation and tailored prompts for installation location.
    • Provided clear instructions for running the binary and checking its version based on the chosen installation path.
  • Improvements

    • Replaced wget with curl for downloading files.
    • Improved user prompts and error handling during installation.

@jcstein jcstein self-assigned this Apr 28, 2025
Copy link
Contributor

coderabbitai bot commented Apr 28, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The script public/celestia-app.sh has been updated to use curl instead of wget for downloading files. The installation flow has been revised: after extracting the binary, the script now checks for the presence of Go and offers a multi-choice prompt to select the installation location for the celestia-appd binary. Based on the user's selection, the script moves or retains the binary, sets permissions, and creates a symlink. It also checks if the Go bin directory is in the user's PATH and provides tailored instructions for running the binary.

Changes

File(s) Change Summary
public/celestia-app.sh Replaced wget with curl for downloads; added Go detection; introduced multi-choice install prompt; updated binary placement logic; added symlink creation and PATH check; improved user messaging and instructions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Script
    participant GoEnv

    User->>Script: Run celestia-app.sh
    Script->>Script: Download tarball & checksum via curl
    Script->>Script: Extract binary
    Script->>GoEnv: Check if Go is installed
    alt Go is installed
        Script->>User: Prompt: Install to Go bin, /usr/local/bin, or keep here?
    else Go not installed
        Script->>User: Prompt: Install to /usr/local/bin or keep here?
    end
    User->>Script: Select install location
    Script->>Script: Move/set permissions as per selection
    Script->>Script: Create symlink in temp dir
    Script->>Script: Check if Go bin is in PATH (if relevant)
    Script->>User: Print tailored run/version instructions
Loading

Possibly related PRs

Poem

🐇
With curl I hop, no more wget to fetch,
Choices for install—just follow my sketch!
Go or no Go, I sniff out your bin,
A symlink I leave, with a wink and a grin.
Now running Celestia is easy as pie,
Just follow my prompts—give it a try!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 270c9f0 and ab3aace.

📒 Files selected for processing (1)
  • public/celestia-app.sh (3 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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 jcstein merged commit f7176ed into main Apr 28, 2025
2 of 5 checks passed
@jcstein jcstein deleted the jcs/improve-app-script branch April 28, 2025 17:52
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.

1 participant