Add Update Notice - Githubissues

openhab / openhab-vscode

VS Code extension for openHAB configuration files

https://marketplace.visualstudio.com/items?itemName=openhab.openhab

Eclipse Public License 2.0

159 stars 47 forks source link

Add Update Notice #250

Closed Confectrician closed 3 years ago

Confectrician commented 3 years ago

Fixes #249

Already done:

Basic things that are needed for showing a webview
Basic "vscode like" page design and first contents
Check for extension updates from the openhab extension
Provide a persistent storage for the to check version changes in the future and store data.

Confectrician commented 3 years ago

Here is a first impression of how the update page looks.

Confectrician commented 3 years ago

@CWempe maybe you can find some time to check the spelling and look of the update page.

Currently the Page will show up on each extension startup. I am now starting with the logic to determine an extension update.

Confectrician commented 3 years ago

Latest change provides following behavior:

Extension check current version in storage with the one that is activated
If they are not the same the update notice will be shown
Otherwise extension will startup normal
Update notice can be re-visited with a new command "updateNotice" via cmd + shift + p

CWempe commented 3 years ago

Im am no expert in english either, but here are some thoughts:

current: take care manually of those. better: take care of those manually.

current: Tip: Have a look at the Latest Release information Maybe the official addon discription would be a better place for a changelog and information about breaking changes?! The normal user should not care about a source code management system like GitHub. 😉 On the other hand the official description might get overloaded. 🤔

btw: I just noticed there is a changelog tab in the marlked place:

current: openhab.karafCommand | openhab.karafCommand Do not mention a parameter that has not been changed in the changed parameter table. But didn't you changed it already? Maybe in another PR...

current: you should adapt those names on your custom configuration better: you should adapt those names in your configuration Is it in or on? I think every configuration is a custom configuration.

Looks good so far! 👍

I tested v1.0.0-pr-250-6141a3d.

Confectrician commented 3 years ago

Thanks for the typo/grammar checks. I have incorporated all of them.

current: Tip: Have a look at the Latest Release information Maybe the official addon discription would be a better place for a changelog and information about breaking changes?! The normal user should not care about a source code management system like GitHub. 😉 On the other hand the official description might get overloaded. 🤔

Did you click the link for testing? Every release has a description field. That's where we also list changes/breaking changes for openHAB currently.

My idea was to provide the needed information there additionally to those small informations. It is public reachable and the link will work for every release, so we don't have to remember to change it every time.

Here is an example from openHAB Distro with much explanations in the description. https://github.com/openhab/openhab-distro/releases/tag/3.1.0.M2 That's what i was aiming for without too much wall of text but more than currently.

btw: I just noticed there is a changelog tab in the marlked place:

I would have sworn that this is already filled via https://github.com/openhab/openhab-vscode/blob/main/CHANGELOG.md on default. I will check why this is not working currently. Reference: #252

current: openhab.karafCommand | openhab.karafCommand

Typo. Sorry and fixed.

CWempe commented 3 years ago

Did you click the link for testing? Every release has a description field.

I did. And personally I like the release notes on GitHub. But from a user perspective the changelog in the marketplace is more relevant, I think.

If the CHANGELOG.md will get updated and published to the Marketplace that would be the best solution in my opinion.

Confectrician commented 3 years ago

But the changelog is not meant for explanations of how to deal with breaking changes. Basically this is just a documentation of what has changed in which way.

If we would add user descriptions, it would break the mould of its original purpose.

Btw the release notes are just a computed "mini changelog" cut out from changelog.md currently. There is a script which is doing this in our build system.

CWempe commented 3 years ago

If we would add user descriptions, it would break the mould of its original purpose.

Ok, I understand.

Confectrician commented 3 years ago

Anyways i think this will be a huge improvement compared to the current (more or less none) existing migration paths. We can improve and extend this at any point when we recognize that it needs some changes.

I have some things in mind that will make it easy to add changing update instructions (or even other informational messages) into new versions with the codebase introduced here.