Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Only show dev channel add-ons for pre-release NVDA #14693

Closed
wants to merge 2 commits into from

Conversation

seanbudd
Copy link
Member

@seanbudd seanbudd commented Mar 3, 2023

Link to issue number:

Closes nvaccess/addon-datastore-transform#15

Summary of the issue:

The "dev" channel is designed to be used for pre-release versions of NVDA only, and allow installation to incompatible API versions.

Description of user facing changes

Makes "dev" channel add-ons always compatible with pre-release versions of NVDA
Filters incompatible add-ons from the add-on store.
For stable NVDA releases:

  • this removes dev versions
    For NVDA pre-releases:
  • this removes unsupported stable and beta versions, and shows dev versions.

Description of development approach

Check the channel when checking addon compatibility.

filter compatible add-on versions in the main view of the store.

Testing strategy:

Test add-on store views for stable and pre-release NVDA, by changing buildVersion

Known issues with pull request:

None

Change log entries:

None

Code Review Checklist:

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

@seanbudd seanbudd requested a review from a team as a code owner March 3, 2023 03:51
@seanbudd seanbudd changed the base branch from master to addonStore-base March 3, 2023 03:51
@XLTechie
Copy link
Collaborator

XLTechie commented Mar 3, 2023 via email

@seanbudd
Copy link
Member Author

seanbudd commented Mar 3, 2023 via email

@CyrilleB79
Copy link
Collaborator

Is there an impact for legacy add-ons, i.e. the ones migrated from addonFiles to addon-datastore? For some of them, the dev channel was used as what is now called beta channel in the add-on store.

More general note:
With the add-on store some terms have slightly changed their meaning with respect to what was used in the add-on community and on the NVDA Community Add-ons website:

  • "legacy":
    • community website: add-ons declared end-of-life or not compatible with last NVDA version
    • add-on store: add-ons that were migrated from addonFiles to addon-dataStore
  • "dev channel":
    • community website: a channel for early adopters; this covers both the new beta and dev channels of the add-on store
    • add-on datastore: a channel for add-ons working with alpha version of NVDA even when API-breaking NVDA release dev cycle is on-going

@Brian1Gaff
Copy link

Brian1Gaff commented Mar 3, 2023 via email

@seanbudd
Copy link
Member Author

seanbudd commented Mar 6, 2023

We've decided to close this, in favour of allowing any add-on version compatibility check to be manually overwritten.
This covers the use-case of testing unreleased breaking API changes, that the dev channel was intended for.

The documentation proposed in nvaccess/addon-datastore#109 has been updated to match this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add support for pre-release NVDA
4 participants