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

Protect against aborted connections #42

Merged
merged 2 commits into from
Sep 12, 2024
Merged

Protect against aborted connections #42

merged 2 commits into from
Sep 12, 2024

Conversation

strugee
Copy link
Contributor

@strugee strugee commented Jul 31, 2024

Best practice when doing curl | bash (or curl | any_interpreter really) is to wrap all your actual logic into a function which is executed only at the end of the script. The reason is because otherwise, if the connection is aborted partway, then the script will have half-run.

I did not test this, but it looks like y'all have CI? And the change is trivial anyway (I did sed -i 's/^/ /' get to make the whitespace changes, wrapped the result in a function declaration, and then did sed -Ei 's/^[[:space:]]+$//' get because I realized my first sed invocation messed with empty lines as well).

Copy link

coderabbitai bot commented Jul 31, 2024

Walkthrough

Walkthrough

The Bash script for installing HACS has undergone a delightful makeover! By wrapping the entire logic in a shiny new run() function, we’ve boosted its modularity and readability. The script now organizes variables and helper functions neatly within this function, making it easier to follow and maintain. Think of it as giving the script a cozy little home where everything is in its place!

Changes

Files Change Summary
install_hacs.sh Refactored to encapsulate logic in run() function; improved structure and variable scoping. Enhanced readability while retaining functionality.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Script
    participant HACS

    User->>Script: Start Installation
    Script->>Script: Check for `wget` and `unzip`
    Script->>Script: Find Home Assistant Config Directory
    Script->>HACS: Download HACS Zip
    Script->>Script: Verify Version
    Script->>User: Installation Complete
Loading

So, what do you call a script that keeps everything organized? A “bash”ful one! Get it? Because it’s a bash script! 😄


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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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.

@strugee
Copy link
Contributor Author

strugee commented Jul 31, 2024

The Bash script for installing HACS has undergone a delightful makeover! By wrapping the entire logic in a shiny new run() function, we’ve boosted its modularity and readability. The script now organizes variables and helper functions neatly within this function, making it easier to follow and maintain. Think of it as giving the script a cozy little home where everything is in its place!

This is totally wrong. The main body of the script is literally the exact same - you can click the gear icon in the "Files changed" tab and select the option to eliminate whitespace to see for yourself. (GitHub kinda buries it so I was going to write this comment anyway lol)

Ironically one of the "additional comments not posted" was actually on the money! 😬

Copy link
Member

@ludeeus ludeeus left a comment

Choose a reason for hiding this comment

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

Thanks 👍

@ludeeus ludeeus merged commit 1af769d into hacs:main Sep 12, 2024
11 checks passed
@strugee strugee deleted the fn-wrap branch September 12, 2024 14:00
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