Remove deprecated HEOS sign_in/out actions #36724
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation for the Denon HEOS integration has been significantly revised to indicate the deprecation of the Changes
Sequence DiagramsequenceDiagram
participant User
participant HEOS Integration
participant HEOS Account
User->>HEOS Integration: Configure credentials
HEOS Integration->>HEOS Account: Authenticate
Note over HEOS Integration: Credentials stored in configuration
Note over HEOS Integration: Device authenticates independently
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🔇 Additional comments (2)
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
source/_integrations/heos.markdown (2)
213-214: Consider moving the device authentication note to a more prominent locationThis important note about device authentication behavior would be more helpful if placed in the Prerequisites or Configuration sections, as it's crucial information for initial setup rather than being buried in the deprecated action's documentation.
239-239: Add context about sign-out behaviorThe description could be enhanced to explain what functionality is affected after signing out (e.g., loss of access to favorites, playlists, etc.).
Consider updating to:
-Use the sign-out action to sign the connected device out of a HEOS account. An error message is logged if sign-out is unsuccessful. There are no parameters to this action Example action data payload: +Use the sign-out action to sign the connected device out of a HEOS account. After signing out, features like favorites, playlists, and streaming services will be unavailable until signing back in. An error message is logged if sign-out is unsuccessful. There are no parameters to this action. Example action data payload:
source/_integrations/heos.markdown
Outdated
| {% warning %} | ||
| **This action is deprecated and will be removed in the 2025.8.0 release.** Enter your HEOS Account credentials in the [configuration options](#configuration-options) and the integration will manage authentication automatically. | ||
| {% endwarning %} |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add a migration guide for existing users
To help users transition from the deprecated actions to the new configuration-based authentication, consider adding a migration guide section. This would be especially helpful for users who might be using these actions in their automations.
Example addition:
## Migrating from sign_in/sign_out actions
If you're currently using the `heos.sign_in` or `heos.sign_out` actions in your automations:
1. Remove any automations using these actions
2. Enter your HEOS Account credentials in the configuration options
3. The integration will automatically manage authentication
Example of updating an automation that uses sign_in/sign_out:
Before:
```yaml
action:
- service: heos.sign_in
data:
username: [email protected]
password: passwordAfter:
Remove the automation and use the configuration options instead.
<!-- This is an auto-generated comment by CodeRabbit -->
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
andrewsayre
changed the title
That makes it easy! |
home-assistant
bot
removed
the
parent-merged
Proposed change
Removes documentation for the deprecated HEOS sign_in and sign_out actions that will be removed in 2025.8.0.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
Summary by CodeRabbit
heos.sign_inandheos.sign_outactions are deprecated.