Deprecate verify_domain_control service helper #2688
Conversation
📝 Walkthrough""" WalkthroughA new blog post was added to announce the deprecation of the Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant OldDecorator as @verify_domain_control(hass, DOMAIN)
participant NewDecorator as @verify_domain_entity_control(DOMAIN)
participant ServiceCall
participant HomeAssistant
Developer->>OldDecorator: Decorate service function (passes hass)
OldDecorator->>ServiceCall: Receives ServiceCall
ServiceCall->>HomeAssistant: Access HomeAssistant via hass
Developer->>NewDecorator: Decorate service function (no hass needed)
NewDecorator->>ServiceCall: Receives ServiceCall
ServiceCall->>HomeAssistant: Access HomeAssistant directly (has reference)
""" 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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.
Actionable comments posted: 0
🧹 Nitpick comments (4)
blog/2025-06-03-deprecate-verify-domain-control.md (4)
12-14: Convert bare URL to a markdown link and add missing determiner
Replace the bare URL with a named link and insert "the" before thehassobject.- Since release `2025.1` (via core PR https://github.com/home-assistant/core/pull/133062), - a reference to `HomeAssistant` is available as a property of the `ServiceCall` object, - and it became redundant to pass `hass` object to `verify_domain_control`. + Since release `2025.1` (via core PR [#133062](https://github.com/home-assistant/core/pull/133062)), + a reference to `HomeAssistant` is available as a property of the `ServiceCall` object, + and it became redundant to pass the `hass` object to `verify_domain_control`.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
12-12: Bare URL used
null(MD034, no-bare-urls)
16-19: Refine step-by-step instructions for clarity and consistency
Front the goal before the location phrase, remove filler words, and ensure each item ends with a period.- To update your integration: - 1. Replace the decorator as shown in the first example below - 2. (Optional) Move the nested functions to be module-level as shown in the second example below - 3. Test the changes + To update your integration: + 1. Replace the decorator in the first example below. + 2. Move the nested functions to module-level in the second example below. (Optional) + 3. Test the changes.
26-26: Add missing determiner and remove fluff
Insert "The" at the start and drop "simply" for a more authoritative tone.- Minimum change is to simply adjust the decorator + The minimum change is to adjust the decorator.
46-46: Use direct authoritative phrasing and front the goal
Replace recommendation phrasing with a command that starts with the goal.- To reduce code complexity, it is now recommended to move the service functions to be module-level functions + Move the service functions to module-level functions to reduce code complexity.
📜 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)
blog/2025-06-03-deprecate-verify-domain-control.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
`*/**(html|markdown|md)`: - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure t...
*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
blog/2025-06-03-deprecate-verify-domain-control.md
`*/**(html|markdown|md)`: - Use bold to mark UI strings. - If "" are used to mark UI strings, replace them by bold.
*/**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
blog/2025-06-03-deprecate-verify-domain-control.md
`*/**(html|markdown|md)`: - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
*/**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
blog/2025-06-03-deprecate-verify-domain-control.md
`*/**(html|markdown|md)`: - Use sentence-style capitalization also in headings.
*/**(html|markdown|md): - Use sentence-style capitalization also in headings.
blog/2025-06-03-deprecate-verify-domain-control.md
`*/**(html|markdown|md)`: do not comment on HTML used for icons
*/**(html|markdown|md): do not comment on HTML used for icons
blog/2025-06-03-deprecate-verify-domain-control.md
`*/**(html|markdown|md)`: Avoid flagging inline HTML for embedding videos in future reviews for this repository.
*/**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
blog/2025-06-03-deprecate-verify-domain-control.md
🪛 LanguageTool
blog/2025-06-03-deprecate-verify-domain-control.md
[uncategorized] ~25-~25: A determiner appears to be missing. Consider inserting it.
Context: ... Home Assistant 2026.7. ### Examples Minimum change is to simply adjust the decorato...
(AI_EN_LECTOR_MISSING_DETERMINER)
🪛 markdownlint-cli2 (0.17.2)
blog/2025-06-03-deprecate-verify-domain-control.md
12-12: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - developers-home-assistant
- GitHub Check: Header rules - developers-home-assistant
- GitHub Check: Pages changed - developers-home-assistant
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
blog/2025-06-03-deprecate-verify-domain-control.md (1)
17-19: Front goal in step-by-step instructionsAlign with step-by-step guidelines by fronting the goal before details and using an authoritative tone. For example:
-1. Replace the decorator as shown in the first example below -2. (Optional) Move the nested functions to be module-level as shown in the second example below -3. Test the changes +1. Update the decorator by replacing `@verify_domain_control(hass, DOMAIN)` with `@verify_domain_entity_control(DOMAIN)` +2. Refactor nested service handler functions to module level as shown in the second example (optional) +3. Test service calls to ensure the integration functions correctly
📜 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)
blog/2025-06-03-deprecate-verify-domain-control.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
`*/**(html|markdown|md)`: - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure t...
*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
blog/2025-06-03-deprecate-verify-domain-control.md
`*/**(html|markdown|md)`: - Use bold to mark UI strings. - If "" are used to mark UI strings, replace them by bold.
*/**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
blog/2025-06-03-deprecate-verify-domain-control.md
`*/**(html|markdown|md)`: - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
*/**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
blog/2025-06-03-deprecate-verify-domain-control.md
`*/**(html|markdown|md)`: - Use sentence-style capitalization also in headings.
*/**(html|markdown|md): - Use sentence-style capitalization also in headings.
blog/2025-06-03-deprecate-verify-domain-control.md
`*/**(html|markdown|md)`: do not comment on HTML used for icons
*/**(html|markdown|md): do not comment on HTML used for icons
blog/2025-06-03-deprecate-verify-domain-control.md
`*/**(html|markdown|md)`: Avoid flagging inline HTML for embedding videos in future reviews for this repository.
*/**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
blog/2025-06-03-deprecate-verify-domain-control.md
🪛 LanguageTool
blog/2025-06-03-deprecate-verify-domain-control.md
[uncategorized] ~25-~25: A determiner appears to be missing. Consider inserting it.
Context: ... Home Assistant 2026.7. ### Examples Minimum change is to simply adjust the decorato...
(AI_EN_LECTOR_MISSING_DETERMINER)
🪛 markdownlint-cli2 (0.17.2)
blog/2025-06-03-deprecate-verify-domain-control.md
12-12: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - developers-home-assistant
- GitHub Check: Header rules - developers-home-assistant
- GitHub Check: Pages changed - developers-home-assistant
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
blog/2025-06-03-deprecate-verify-domain-control.md (3)
17-19: Add missing periods to list items.Each numbered item is a complete sentence and should end with a period for consistency with the Microsoft Style Guide.
Apply this diff:
-1. Replace the decorator as shown in the first example below +1. Replace the decorator as shown in the first example below. -2. (Optional) Move the nested functions to be module-level as shown in the second example below +2. (Optional) Move the nested functions to be module-level as shown in the second example below. -3. Test the changes +3. Test the changes.
26-27: Use imperative phrasing for the minimal change introduction.Front the goal and use the imperative mood to match step-by-step style:
-Minimum change is to simply adjust the decorator +For minimal change, adjust the decorator as follows:
47-48: Rephrase recommendation to imperative tone.Change the passive recommendation to an imperative instruction:
-To reduce code complexity, it is now recommended to move the service functions to be module-level functions +Reduce code complexity by moving service functions to module-level functions.
📜 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)
blog/2025-06-03-deprecate-verify-domain-control.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
`*/**(html|markdown|md)`: - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure t...
*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
blog/2025-06-03-deprecate-verify-domain-control.md
`*/**(html|markdown|md)`: - Use bold to mark UI strings. - If "" are used to mark UI strings, replace them by bold.
*/**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
blog/2025-06-03-deprecate-verify-domain-control.md
`*/**(html|markdown|md)`: - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
*/**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
blog/2025-06-03-deprecate-verify-domain-control.md
`*/**(html|markdown|md)`: - Use sentence-style capitalization also in headings.
*/**(html|markdown|md): - Use sentence-style capitalization also in headings.
blog/2025-06-03-deprecate-verify-domain-control.md
`*/**(html|markdown|md)`: do not comment on HTML used for icons
*/**(html|markdown|md): do not comment on HTML used for icons
blog/2025-06-03-deprecate-verify-domain-control.md
`*/**(html|markdown|md)`: Avoid flagging inline HTML for embedding videos in future reviews for this repository.
*/**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
blog/2025-06-03-deprecate-verify-domain-control.md
🪛 LanguageTool
blog/2025-06-03-deprecate-verify-domain-control.md
[uncategorized] ~25-~25: A determiner appears to be missing. Consider inserting it.
Context: ... Home Assistant 2026.7. ### Examples Minimum change is to simply adjust the decorato...
(AI_EN_LECTOR_MISSING_DETERMINER)
🔇 Additional comments (1)
blog/2025-06-03-deprecate-verify-domain-control.md (1)
7-15: LGTM: Summary is clear and concise.The “Summary of changes” section succinctly explains the deprecation and replacement, uses direct tone, and follows sentence-style capitalization.
There was a problem hiding this comment.
Pull Request Overview
A blog post announcing the deprecation of the verify_domain_control service helper and guiding integrators on migrating to the new verify_domain_entity_control helper in Home Assistant.
- Deprecation announcement for
verify_domain_controland replacement withverify_domain_entity_control - Migration steps and timeline for removal (2026.7)
- Code examples illustrating decorator update and module-level function refactoring
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
Marked as draft until core PR is accepted |
Proposed change
Blog post for home-assistant/core#146057
Type of change
Checklist
Additional information
Summary by CodeRabbit
verify_domain_controlservice helper in Home Assistant.verify_domain_entity_controlhelper.