Topics

Add-on Updater 19.02.2 coming soon (another mandatory update), enforcing three-part NVDA compatibility flags #addonrelease

 

Dear NVDA community,

 

Yes, Add-on Updater 19.02.2 is coming soon. But before going into that, a bit of an explanation regarding what will happen:

 

A few days ago NV Access people announced a revised approach to how NVDA will check for add-on compatibility. Previously, add-on authors were advised to specify minimum and last tested NVDA version in the form year.major (e.g. 2018.4). Any add-ons that didn’t come with these flags, especially those that lacked last tested flag, were considered incompatible. In contrast, the new approach will keep backward compatibility by having a base API version to which all add-ons are considered compatible with, and add-on authors advised to update minimum version flag when breaking changes are introduced.

 

At the same time, the compatibility range manifest style has changed. Previously ad-on authors were told to specify compatibility version in the form year.major. Now, authors must include minor release as well, so it becomes year.major.minor (e.g. 2018.4.0). For the most part, authors can leave the minor release as 0.

 

To enforce the new approach, starting from version 19.02.2, Add-on Updater will advise you to contact add-on authors and request for a re-release if compatibility flags do not comply with the newly revised format. For example, if an add-on update specifies 2018.4.0 as minimum NVDA version, Add-on Updater won’t complain; but if minimum NVDA version is 2018.4 (just year.major), Add-on Updater will warn you of this fact and refuse to update until a version of the add-on that does come with revised compatibility flag format is released.

 

A few things to note:

 

  • To give time for authors and users to communicate with each other regarding add-on compatibility checks, this new check will be enforced if and only if you are running any form of NVDA 2019.1 (alpha, beta, RC, stable).
  • This change will become permanent (as far as Add-on Updater is concerned) around the time NVDA 2019.1 release candidate (RC) is released.
  • For authors, you do not have to specify minor release as part of compatibility range statement (if your add-on requires NVDA 2018.4.0 in the manifest, you can just say that NVDA 2018.4 is required).

 

In addition to the change outlined above, Add-on Updater 19.02.2 will enable update checks for one or two add-ons approved for distribution on community add-ons website.

 

Thank you.

Cheers,

Joseph

 

Hi,

Regarding add-on reviews, I’ll start looking for compatibility flags as part of basic review/user experience portion once NVDA 2019.1 is released.

Cheers,

Joseph

 

From: nvda-addons@nvda-addons.groups.io <nvda-addons@nvda-addons.groups.io> On Behalf Of Joseph Lee via Groups.Io
Sent: Monday, February 4, 2019 9:41 PM
To: 'NVDA screen reader development' <nvda-devel@...>
Subject: [nvda-addons] Add-on Updater 19.02.2 coming soon (another mandatory update), enforcing three-part NVDA compatibility flags #AddonRelease

 

Dear NVDA community,

 

Yes, Add-on Updater 19.02.2 is coming soon. But before going into that, a bit of an explanation regarding what will happen:

 

A few days ago NV Access people announced a revised approach to how NVDA will check for add-on compatibility. Previously, add-on authors were advised to specify minimum and last tested NVDA version in the form year.major (e.g. 2018.4). Any add-ons that didn’t come with these flags, especially those that lacked last tested flag, were considered incompatible. In contrast, the new approach will keep backward compatibility by having a base API version to which all add-ons are considered compatible with, and add-on authors advised to update minimum version flag when breaking changes are introduced.

 

At the same time, the compatibility range manifest style has changed. Previously ad-on authors were told to specify compatibility version in the form year.major. Now, authors must include minor release as well, so it becomes year.major.minor (e.g. 2018.4.0). For the most part, authors can leave the minor release as 0.

 

To enforce the new approach, starting from version 19.02.2, Add-on Updater will advise you to contact add-on authors and request for a re-release if compatibility flags do not comply with the newly revised format. For example, if an add-on update specifies 2018.4.0 as minimum NVDA version, Add-on Updater won’t complain; but if minimum NVDA version is 2018.4 (just year.major), Add-on Updater will warn you of this fact and refuse to update until a version of the add-on that does come with revised compatibility flag format is released.

 

A few things to note:

 

  • To give time for authors and users to communicate with each other regarding add-on compatibility checks, this new check will be enforced if and only if you are running any form of NVDA 2019.1 (alpha, beta, RC, stable).
  • This change will become permanent (as far as Add-on Updater is concerned) around the time NVDA 2019.1 release candidate (RC) is released.
  • For authors, you do not have to specify minor release as part of compatibility range statement (if your add-on requires NVDA 2018.4.0 in the manifest, you can just say that NVDA 2018.4 is required).

 

In addition to the change outlined above, Add-on Updater 19.02.2 will enable update checks for one or two add-ons approved for distribution on community add-ons website.

 

Thank you.

Cheers,

Joseph