I noticed the same thing and even wrote a draft of a post here. But then I deleted it, because I expected reactions stating that all is fine, because itâs just 3 clicks away. So writing about this seemed not really productive.
However, since you did bring the topic, I want to voice my support.
It is especially jarring, because the main update changelog is so very nicely written. I write public changelogs in my work, so I know how much work, skill and experience must be behind that. The result may look effortless, but I bet it isnât.
So the main update is written very well, with great effort taken to make it nice read even for people completely new to HA. But then the patches are just copy pasted list from github. And I get it, writing a proper nice changelog for them would be time consuming and would have to delay the patch. So I understand if this canât be done.
Still, I think the feedback is valid and itâs good to share.
So how do I think this specific case for uiprotect would be handled in a perfect world?
- All those entries should be merged into one.
- A human readable sentence would state that UniFi Protect integration was updated. It can mention that the uiprotect version was updated from 0.4.1 to 1.7.2.
- Some hint on what was changed (was it bugfixes, performance improvement, code optimization, new feature support), doesnât need to be super detailed. The main point is so that users can figure out if itâs something that affects them and if they should check the details.
- A link to the full changelog:
Comparing v0.4.1...v1.7.2 ¡ uilibs/uiprotect ¡ GitHub
Now, as noted above, Iâm perfectly aware this takes time and effort, and so the answer could very well be that it wonât be done. This is just the uiprotect example, it would look different for other cases, where a changelog may not be available at all. For example, this one:
Bump goodwe to 0.3.6 (@mletenay - #119646)
here the dev did write what this was for specifically, this could have been basically copied:
Update the goodwe library to 0.3.6, bringing fix to meter export values to ETT/ESN inverters.
while this one is again different:
Bump buieradar to 1.0.6 (@mjj4791 - #119433)
as it says:
Bump buienradar library to 1.0.6 to resolve #118403
and for this specific case I think the patch notes should just directly have the #118403 bugfix.
So, to sum up, a lot of work, I get it if it wonât be done. But please, do not say itâs all good as it is and devaluate the feedback we are sharing. We wouldnât be sharing it if it didnât bother us. Thank you.