Require stable API version for submitting an add-on using stable channel #33
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
michaelDCurran
approved these changes
Oct 11, 2023
This was referenced Oct 12, 2023
seanbudd
added a commit
to nvaccess/addon-datastore
that referenced
this pull request
Oct 12, 2023
Relates to nvaccess/addon-datastore-validation#33 nvaccess/nvda#15607 As 2024.1 is in alpha, add-ons using the 2024.1 API should not be marked as stable using the stable channel. This PR marks them as dev.
seanbudd
added a commit
to nvaccess/nvda
that referenced
this pull request
Oct 12, 2023
Link to issue number: Relates to nvaccess/addon-datastore-validation#33 Summary of the issue: Information was lacking on the stability of the add-on API and translation strings at various stages of the release process. This makes the work required or expected for add-on developers and translators unclear. Description of user facing changes Expands release process to include more information for translators and add-on developers.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently add-on authors are able to submit stable add-ons to the 2024.1 API.
However, the 2024.1 API is not stable yet.
If a user attempts to install an add-on that is currently marked as compatible with 2024.1, with the final NVDA 2024.1 release, they will encounter errors.
Add-on authors are encouraged to submit add-ons using the "dev" version to NVDA APIs which are not yet released.
This PR makes it required for an add-on to use dev or beta channels when submitting an add-on to an API version that is still in development, and is yet to be released.
For example:
"experimental": trueuntil RC is reached