-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Introduce Home Assistant Labs #2866
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
Merged
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
8e4a1eb
Introduce Home Assistant Labs
frenck 1dbf3fc
Clean up duplicate
frenck 0ada83c
Update docs/development/labs.md
frenck 23c274b
Apply suggestion from @frenck
frenck aef9c8c
Apply suggestion from @frenck
frenck 8e743aa
Update blog/2025-11-20-labs-preview-features.md
frenck 2801c02
Update blog/2025-11-20-labs-preview-features.md
frenck acb155b
Update docs/development/labs.md
frenck d03d5e3
Process feedback, process upstream changes, align with end-user docs
frenck 9e67628
More tuning
frenck aa0b802
More tuning
frenck 3d8316d
More tuning
frenck 38ae99d
More tuning
frenck File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| author: Frenck | ||
| authorURL: https://github.com/frenck | ||
| authorImageURL: https://avatars.githubusercontent.com/u/195327?v=4 | ||
| title: "Introducing Labs: Preview features before they become standard" | ||
| --- | ||
|
|
||
| We're excited to announce a new system for shipping preview features in Home Assistant: **Labs**. Labs provides a standardized way for integrations to offer fully tested features that users can opt into before they become standard, allowing us to gather feedback and refine the design based on real-world usage. | ||
|
|
||
| ## What are Labs preview features? | ||
|
|
||
| Labs preview features are different from beta testing. While beta testing evaluates the stability of upcoming Home Assistant releases, Labs is about refining user interfaces and design. Labs features are fully tested and functional, but their design and behavior may still change as we gather real-world usage and feedback. This means they might have breaking changes, be extended with new functionality, or even be removed if they don't work out. | ||
|
|
||
| Think of it this way: | ||
|
|
||
| - **Beta**: Evaluates the stability of upcoming Home Assistant releases | ||
| - **Labs**: Fully tested features with evolving design and user interface, refined through real-world usage and feedback | ||
|
|
||
| ## How it works | ||
|
|
||
| Integrations declare preview features in their `manifest.json` with links for feedback, documentation, and issue reporting. Users can then enable these features in **Settings** → **System** → **Labs**, and they activate immediately without requiring a restart. The integration code checks whether a feature is enabled and responds accordingly. | ||
|
|
||
| ## Why Labs? | ||
|
|
||
| Many of our most significant improvements benefit from real-world testing before becoming standard. Labs provides: | ||
|
|
||
| 1. **Structured feedback channels**: Each feature has dedicated URLs for feedback, documentation, and issue reporting | ||
| 2. **Runtime activation**: Features enable and disable instantly, no configuration updates or restart required | ||
| 3. **Clear expectations**: Users know they're trying fully tested features whose design may change based on feedback | ||
| 4. **Iterative development**: Integrate user feedback directly into the development process | ||
|
|
||
| ## Example: Kitchen Sink special repair | ||
|
|
||
| The [Kitchen Sink](https://www.home-assistant.io/integrations/kitchen_sink/) demo integration includes a working example. When enabled, the "special repair" feature creates a repair issue to demonstrate how Labs features can interact with other Home Assistant integrations. See the [developer documentation](/docs/development/labs#complete-example-kitchen-sink-special-repair) for the complete implementation. | ||
|
|
||
| ## Getting started | ||
|
|
||
| Ready to add a Labs preview feature to your integration? Check out our [comprehensive guide](/docs/development/labs) which covers: | ||
|
|
||
| - When to use Labs (and when not to) | ||
| - How to define features in your manifest | ||
| - Implementation patterns for backend and frontend features | ||
| - Runtime activation requirements | ||
| - Testing approaches | ||
| - Feature lifecycle (preview → standard or removal) | ||
|
|
||
| ## What's next? | ||
|
|
||
| We encourage integration developers to consider Labs for: | ||
|
|
||
| - Major UI changes or redesigns | ||
| - Significant architectural changes that benefit from real-world testing | ||
| - Features where user feedback will shape the final design | ||
|
|
||
| Labs is **not** for: | ||
|
|
||
| - Permanent configuration options (use integration options instead) | ||
| - Minor changes that can go directly into releases | ||
| - Features with critical bugs or that are fundamentally incomplete | ||
|
|
||
| ## Try it yourself | ||
|
|
||
| Want to see Labs in action? Install the Kitchen Sink demo integration and enable the "Special repair" feature in Settings → System → Labs. You'll see firsthand how preview features work. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.