Add changelog dialog to show when the app is updated #2195
Merged
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.
Summary
Fixes: #1162
Uses a library to help show a changelog prompt that is themed for day and night. The dialog will show up after the app is updated and can be accessed in settings as well.
As the github changelog won't be helpful to all users its probably in our best interest to decide on what to add in the changelog. There is some room for HTML like for emphasizing a breaking change. Probably a good time to discuss the format but I wanted to get this out so users don't have surprises like we saw with the new persistent notification.
During beta releases we should keep the version as
Beta
and only update it to the release version when we are ready to cut a release. This will allow us to keep the changelog for the release growing while we remain in beta. Again some of this we can decide to change later if we feel we need to based on user feedback and anything else we find during discussions.Screenshots
Link to pull request in Documentation repository
Documentation: home-assistant/companion.home-assistant#
Any other notes