Added ability to see changelog from the add-on store and Updatable add-ons dialog#18816
Added ability to see changelog from the add-on store and Updatable add-ons dialog#18816seanbudd merged 65 commits intonvaccess:masterfrom
Conversation
|
I'm also working locally modifying files of the addon-datastore-validation repo. Also this would need to be added to the documentation (metadata) of the addon-datastore repo. I'll work on this if the direction of this PR is right. |
|
I think the most useful place to read the change log would be from the add-on update dialog. I think from the add-on store lists, it should be a button like |
|
@seanbudd, I'm trying to convert markdown to HTML with the markdown.markdown function, but the manifest model doesn't support the strip method, and the conversion is not performed. I have displayed the browseable message with a button from the context menu, but seems that markdown conversion is difficult to achieve with the manifest. |
|
@nvdaes wouldn't calling |
|
Sean wrote:
Thanks! It works now. |
…ndicate that this will open a dialog
|
Now we can see the changelog from the installed add-ons list using Actions or the context menu, and when updatable add-ons are found, from the Update add-ons dialog.
|
|
Descriptions were presented instead of changelogs in the updatable add-ons dialog, since I used the description key for testing. @seanbudd , when I try to use the changelog key, errors are raised since changelog is not available from data. Perhaps would be better to add changelog to addon-datastore-validation before finishing this PR? |
|
I think that we can finish this PR before working in addon-datastore-validation. Now I don't get errors. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds changelog viewing functionality to the NVDA add-on store and updatable add-ons dialog. Users can now view changelog information for add-ons when available, helping them make informed decisions about updates and understand what features or fixes are included in new versions.
- Added changelog property to add-on models and store data structures
- Created a new "What's new" action in the add-on store to display changelog in browse mode with markdown support
- Replaced the simple list in the updatable add-ons dialog with the full store virtual list to enable context menu access
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| user_docs/en/userGuide.md | Added documentation section explaining the new changelog feature |
| user_docs/en/changes.md | Added changelog entry and updated developer documentation about markdown support |
| source/gui/addonStoreGui/viewModels/store.py | Added new "What's new" action with markdown rendering and UI display logic |
| source/gui/addonStoreGui/controls/messageDialogs.py | Replaced simple list with full virtual list in updatable add-ons dialog |
| source/addonStore/models/addon.py | Added changelog property to add-on model classes |
| projectDocs/dev/developerGuide/developerGuide.md | Updated developer documentation to mention markdown formatting support |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
@seanbudd , thanks for fixing the size of the new add-ons list. I think that all is done here. |
Qchristensen
left a comment
There was a problem hiding this comment.
This will be helpful, thank you.
|
@nvdaes - yes please update the schema in the validation repo when you can |
Fixes #18991 Fixes a bad merge conflict fix between #18816 and #18974 Summary of the issue: add-on store cannot open Description of user facing changes: add-on store can open again Description of developer facing changes: none Description of development approach: fix merge conflict Testing strategy: add-on store can open again
Link to issue number:
Fixes #14041
Summary of the issue:
Users may want to see changes included in the current version of add-ons, especially to decide if they want to update them, and to get an idea of new features, bug fixes and so on.
Description of user facing changes:
List of changes will be shown in browse mode. If changes are writen in markdown, they will be rendered in formatted HTML. The title of that message will show the add-on version name, and buttons will be available to copy the info and close the browseable message.
Description of developer facing changes:
self.addonsListof theUpdatableAddonsDialogclass is a subclass of theAddonVirtualList.Description of development approach:
Testing strategy:
source/addonStore/models/addon.py, in the_createStoreCollectionFromJsonfunction, add the following code just for testing:Check that changelog can be shown just for this add-on.
Also, changelog in markdown has been created in the manifest and in the store collection, to check that markdown is properly rendered in HTML in the store and in the Updatable add-ons dialog.
Tests have been done with the resourceMonitor add-on to check that the context menu can be used from the Updatable add-ons dialog.
Known issues with pull request:
Sometimes, NVDA says thw word "panel" when the changelog is opened.
Code Review Checklist: