release: 0.18.1 (refresh_tree $state ordering + consumer contract guide) - #34
Merged
Conversation
Pure-fix release. No API change, no ebus-mqtt-client floor bump. - fix: Device.refresh_tree() now publishes a device's own $state after its descendants rather than before, so a device no longer announces ready while the children its $description names have published nothing (#31, #32). Thanks to @cayossarian. - docs: doc/consuming-a-homie-tree.md, the consumer-side contract guide (#33). Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Pure-fix release. No API change, no
ebus-mqtt-clientfloor bump, so PATCH rather than MINOR: everyFixed-only release in this changelog is a patch (0.1.7, 0.2.2, 0.3.1), and the tightest precedent is 0.2.2, itself aDevice.refresh_tree()behaviour-only change.Contents
Device.refresh_tree()now publishes a device's own$stateafter its descendants rather than before, so a device no longer announcesreadywhile the children its$descriptionnames have published nothing.on_connectcallsrefresh_tree()on both the initial connect and every reconnect, so this was the normal path. The set of messages is unchanged; only their order is. (refresh_tree() publishes a device's $state before its children, so the root announces ready to an empty tree #31, fix: publish a device's $state after its children in refresh_tree #32, thanks to @cayossarian)doc/consuming-a-homie-tree.md, the consumer-side contract guide. (docs: add the consumer-side contract guide (consuming-a-homie-tree) #33)Verification
548 passedruff checkandruff format --checkclean on the pinned 0.15.21__version__is the single source of truth; the publish workflow fails the run if the tag does not equalv+__version__