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
Add minor version to config entries #105479
Merged
Merged
Conversation
This file contains 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
Tests are needed |
emontnemery
requested review from
balloob,
synesthesiam,
frenck,
Kane610,
elupus and
marcelveldt
as code owners
December 11, 2023 13:56
emontnemery
requested review from
bachya,
bdraco,
hunterjm,
bieniu,
OttoWinter,
jesserockz,
cgarwood,
dgomes,
joostlek and
jpbede
as code owners
December 11, 2023 14:52
joostlek
reviewed
Dec 11, 2023
joostlek
approved these changes
Dec 11, 2023
emontnemery
force-pushed
the
config_entries_minor_version
branch
from
December 11, 2023 17:37
216c3d7
to
08e2dad
Compare
emontnemery
requested review from
thecode,
chemelli74,
epenet and
cgtobi
as code owners
December 11, 2023 17:37
frenck
approved these changes
Dec 12, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @emontnemery 👍
../Frenck
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Proposed change
Add
minor_version
to config entries to allow backwards compatible config entry version changesIf minor versions differ but major versions are same, and the integration does not implement
async_migrate_entry
, integration setup will be allowed to continue.Rationale
We are very conservative with versioning config entry data because it breaks downgrading to an older version of Home Assistant Core. This means in most cases we don't version, and the integrations instead do a kind of soft upgrade where they may for example do
dict.get
on config entry data which was not in an initial version, transform the data during setup etc.As an alternative to this pattern, this PR adds a minor version, similar to that offered by the storage helper.
A bump of the minor version should be done whenever the newly added, or otherwise changed, data does not break older versions.
Type of change
Additional information
Checklist
ruff format homeassistant tests
)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest
.requirements_all.txt
.Updated by running
python3 -m script.gen_requirements_all
..coveragerc
.To help with the load of incoming pull requests: