0.110: Speed! OpenZWave beta, HomeKit Cameras, ONVIF, Calendars

General comment related how breaking changes are communicated and maybe also part of the YAMLGate noise.

This relates to some - not all - breaking changes which are deprecating and later removing YAML configuration of an integration and replace it by GUI config.
My evaluation is that the users are not always given a clear migration instruction how to go from YAML to GUI. And it is not always the same way it is done so you cannot assume it always works the same way

In some cases you cannot migrate, and have to setup the integration again. In some cases upgrading pulls in YAML content and YAML is from then on ignored and can be deleted. In some cases YAML wins over GUI in deprecation period, but then what when the YAML support is removed?

The migration is normally not described in the main documentation. And I agree with that because it becomes confusing word-cruft that confuses users that just start using the integration.
Best is to add the few lines of text in the release note. Then you have the info when you need it.

In this 0.110 release a GOOD example of how to write the release note is the Manual Alarm Panel. I use this and I am affected by this breaking change. The release note gives exactly the information I need to upgrade to 0.110. This makes the breaking change a little annoying but easy to live with and I will have forgotten the pain in an hour.

A less good example is Mill integration (which I do not use). The release note says that YAML is removed and the integration now uses GUI. But not a word about how to migrate. Not in release note. Not in documentation. Not even in the linked PR. If the migration is that the info is pulled over and you can delete the YAML after upgrading HA, then it should be stated in the release note. It takes less than 10 words.

Another almost perfect example is the breaking change for Blink. It says that the info is pulled in. And I assume you can delete the YAML after the upgrade. It could say that and there would be no doubt.

In general. Many of you do a great job with the release notes. But there are still some of you that could have a huge positive impact to upgraders by writing 1-2 lines of release note text describing how to migrate. And only the author of the code change knows this detail so it is difficult for the rest of us to help. I am sure you all try to do your best and simply do not think about it.

22 Likes