jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-22 16:56:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add blog post about config entry minor version (#2015)

Browse Source 
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Erik Montnemery 2023-12-27 13:18:16 +01:00 committed by GitHub
parent 11e231b954
commit f8bc8bfc91
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
blog/2023-12-18-config-entry-minor-version.md Normal file
View File

@ -0,0 +1,18 @@
---
author: Erik Montnémery
authorURL: https://github.com/emontnemery
title: "Config entry now supports minor versions"
---
Config entry now supports minor versions.
If minor versions differ, but major versions are the same, the integration setup will be allowed to continue even if the integration does not implement `async_migrate_entry`. This means a minor version bump is backwards compatible, unlike a major version bump which causes the integration to fail setup if the user downgrades HA Core without restoring configuration from backup.
### Background
We have been 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 that was not in an initial version, transform the data during setup etc.
By introducing minor versions similar to that already offered by the storage helper, this pattern is no longer recommended.
A bump of the minor version should be done instead whenever the newly added, or otherwise changed, data does not break older versions.
More details can be found in the [documentation on config entry migration](docs/config_entries_config_flow_handler#config-entry-migration) and in [core PR #105749](https://github.com/home-assistant/core/pull/105479).