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

🚑 Fix shutdown addon command #369

Merged
merged 1 commit into from
Jun 26, 2024

Conversation

sinclairpaul
Copy link
Member

@sinclairpaul sinclairpaul commented Jun 25, 2024

Proposed Changes

Fix addon shutdown command, likely due to changes in S6 no longer functions, this aligns with the tear down commands within the service runs.

Summary by CodeRabbit

  • Bug Fixes
    • Updated shutdown command to ensure proper system shutdown when in 'netserver' mode.
    • Adjusted shutdown command to use a specific script when shutdown_host is true, improving shutdown reliability.

@sinclairpaul sinclairpaul added the bugfix Inconsistencies or issues which will cause a problem for users or implementors. label Jun 25, 2024
Copy link

coderabbitai bot commented Jun 25, 2024

Walkthrough

The nut.sh script has been modified to update the shutdown behavior. Specifically, when running in netserver mode, the shutdown command has been changed to use /run/s6/basedir/bin/halt instead of the previous command. Additionally, a new condition has been added to set the shutdown command to /usr/bin/shutdownhost if shutdown_host is true, enhancing how shutdown processes are managed.

Changes

File Change Summary
.../cont-init.d/nut.sh Updated shutdowncmd assignment for netserver mode to use /run/.../halt. Added condition to set shutdowncmd to /usr/bin/shutdownhost when shutdown_host is true.

Poem

In the script where the commands reside, 🖥️
A little tweak, a shift in stride. 🎵
Netservers halt with a new command,
A smoother shutdown, neat and planned.
Host shutdowns now clear and bright, 🌟
Thanks, nut.sh, for doing it right!
~ CodeRabbit 🐇✨


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

Copy link

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between af4c877 and f9df7de.

Files selected for processing (1)
  • nut/rootfs/etc/cont-init.d/nut.sh (1 hunks)
Additional context used
Shellcheck
nut/rootfs/etc/cont-init.d/nut.sh

[error] 1-1: This shebang was unrecognized. ShellCheck only supports sh/bash/dash/ksh. Add a 'shell' directive to specify. (SC1008)

Additional comments not posted (3)
nut/rootfs/etc/cont-init.d/nut.sh (3)

117-117: Update to shutdown command is appropriate.
The update to use /run/s6/basedir/bin/halt aligns with the described changes in the S6 overlay system. This should ensure the shutdown command functions as expected.


118-120: Conditional logic for shutdown command is clear and effective.
The use of bashio::config.true 'shutdown_host' to conditionally change the shutdowncmd to "/usr/bin/shutdownhost" is a good approach. It provides flexibility based on the configuration and ensures that the appropriate action is taken based on the host's needs.


Line range hint 1-1: Shebang might not be recognized by some tools.
The shebang used (#!/command/with-contenv bashio) is specific to the Hass.io environment and might not be recognized by standard tools like ShellCheck. Consider adding a comment explaining this for clarity and future maintenance.

@sinclairpaul sinclairpaul merged commit ddb77a2 into hassio-addons:main Jun 26, 2024
12 checks passed
@sinclairpaul sinclairpaul deleted the fix-shutdown branch June 26, 2024 00:34
@github-actions github-actions bot locked and limited conversation to collaborators Jun 27, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bugfix Inconsistencies or issues which will cause a problem for users or implementors.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant