-
-
Notifications
You must be signed in to change notification settings - Fork 7.8k
Make host required for hddtemp #39942
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
base: next
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR makes the host
setting mandatory for the HDDTemp integration by adding it to the example configuration and updating the schema to mark it as required.
- Added
host
field to the YAML example underplatform: hddtemp
- Changed the
host
schema property fromrequired: false
(with a default) torequired: true
Comments suppressed due to low confidence (1)
source/_integrations/hddtemp.markdown:53
- [nitpick] Update this description to note that
host
is now required and has no default (for example: 'Host wherehddtemp
is running. This field is required; no default will be applied.').
description: Host where `hddtemp` is running.
📝 WalkthroughWalkthroughThe Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Configuration
participant HDDTempIntegration
User ->> Configuration: Provide configuration with explicit host
Configuration ->> HDDTempIntegration: Pass required host parameter
HDDTempIntegration ->> HDDTempIntegration: Connect to specified host
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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
🧹 Nitpick comments (1)
source/_integrations/hddtemp.markdown (1)
41-44
: Prefer a placeholder over a concrete IP in the exampleHard-coding a private-network address (
192.168.1.2
) can mislead users into thinking they must use that exact value. Consider using a placeholder (e.g.<HOST_IP>
or127.0.0.1
) or adding an inline comment to indicate that the address should be replaced with the actual host runninghddtemp
.- host: 192.168.1.2 + # Replace with the address of the machine running hddtemp + host: <HOST_IP>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/hddtemp.markdown
(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_integrations/hddtemp.markdown (1)
53-55
: Schema update looks good – verify other pages no longer mention the old defaultMarking
host
asrequired: true
with no default is consistent with the core change. Please do a quick sweep of the documentation to ensure there are no remaining references to the previouslocalhost
default (e.g. release notes, migration guides, or other integration pages) to avoid contradictory guidance.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, @edenhaus 👍
Proposed change
SSIA
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit
Documentation
New Features