Repository navigation
Let plugins offer optional settings without blocking the integration - #1088
Merged
Merged
Conversation
manuelmayer-dev
deleted the
feature/optional-integration-settings-1022
branch
September 29, 2026 18:25
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #1022
Summary
Plugins can return false from IConfigFlowProvider.RequiresConfiguration, so a config flow that only holds optional settings no longer disables the integration or marks it as needing setup. The flag travels in the config-flow describe payload, and the setup flows guide documents the zero-entry state.
Testing
Release build and full test suites pass, with new host, protocol, SDK, plugin contract and desktop UI tests, including old-plugin payloads without the field. Verified against a disposable host with a scratch plugin: without an entry it runs and its actions are Ready, saving and removing the settings reinitializes it, and the detail page shows Ready.
Plugin SDK / API compatibility
[Obsolete]and[MacroDeckDeprecated], is in the deprecation registry, and still worksChecklist