Skip to content

Add-on manifest: add 'changelog' key to document changes for the latest add-on release#18672

Merged
SaschaCowley merged 8 commits intonvaccess:masterfrom
josephsl:i14041addonManifestChangelogKey
Aug 19, 2025
Merged

Add-on manifest: add 'changelog' key to document changes for the latest add-on release#18672
SaschaCowley merged 8 commits intonvaccess:masterfrom
josephsl:i14041addonManifestChangelogKey

Conversation

@josephsl
Copy link
Copy Markdown
Contributor

Link to issue number:

Partially closes #14041

Summary of the issue:

NV Access add-on store does not show changelog for latest add-on releases.

Description of user facing changes:

Lays the foundation to display add-on changelog if defined.

Description of developer facing changes:

Adds 'changelog' to add-on manifest key definitions and makes the vlaue translatable.

Description of development approach:

Adds a new add-on manifest key named 'changelog' to document changes between previous and latest add-on releases. This key is translatable and is documented to instruct add-on authos on its usage and necessity.

Testing strategy:

Manual: requires building add-ons with "changelog" manifest key/value defined.

Known issues with pull request:

None

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

@coderabbitai summary

…4041.

Add 'changelog' add-on manifest key to let add-on authors document changes between previous and curren add-on versions. This will be shown in the add-on store when users browse add-ons in scenarios including updating add-ons and reviewing latest changes.
@josephsl josephsl requested a review from a team as a code owner August 12, 2025 04:17
@josephsl josephsl requested a review from SaschaCowley August 12, 2025 04:17
@josephsl
Copy link
Copy Markdown
Contributor Author

josephsl commented Aug 12, 2025

Hi,

I would like to request review on dev documentation (the code looks okay but I want to make sure that the usage and necessity of the changelog manifest key is clearly written for add-on authors). Further, this PR provides the foundation to be employed in the add-on store GUI (which I would like to pass on at this time i.e. seeking someone to join the work).

Thanks.

@seanbudd seanbudd added this to the 2026.1 milestone Aug 13, 2025
@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Aug 14, 2025
@nvdaes
Copy link
Copy Markdown
Collaborator

nvdaes commented Aug 17, 2025

I think that I may try to work on the gui, so that the changelog is shown in the details panel or something, since I've worked previous to on the store gui and I'm very interested in this feature, but I'll wait until this PR is merged.
Then, if I'm successful with the work, in NVDA's changelog I'll mention josephsl and nvdaes.

Comment thread user_docs/en/changes.md Outdated
@SaschaCowley SaschaCowley enabled auto-merge (squash) August 19, 2025 06:05
@SaschaCowley SaschaCowley merged commit a23f1ab into nvaccess:master Aug 19, 2025
22 checks passed
@josephsl josephsl deleted the i14041addonManifestChangelogKey branch September 11, 2025 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Changelog on addons updates

4 participants