[nvda-addons] Add-on template: proposed changes to support add-on updates and channel selection

  • From: "Joseph Lee" <joseph.lee22590@xxxxxxxxx>
  • To: <nvda-addons@xxxxxxxxxxxxx>
  • Date: Sun, 26 Mar 2017 20:39:43 -0700

Fellow add-ons community members,

 

As some of you may know, I'm working on ability for NVDA to check for and
download add-on updates. This project consists of a client UI and update
experience, add-on update info retriever and protocols, and a server-side
implementation to gather add-on versions and other metadata under one roof.
More info about this project can be found at:

https://github.com/nvaccess/nvda/issues/3208

 

At the moment the client UI is done. Once NV Access comes up with a protocol
and server-side facility, I'll update my client UI bits to point to new
capabilities. But this is just the start, as bulk of this project relies on
cooperation with add-on writers when it comes to making our add-ons support
updates. In order to do so, I propose the following changes to the add-on
template and manifests:

 

*       Update channel: I propose adding a new manifest key named
"updateChannel" that'll let NVDA know which update channel should be
consulted when checking for an add-on update. By default, this key will hold
a null string (None), or for add-ons that does not support updates, this key
will not be defined. For most add-ons, possible channels could be "stable"
and "dev". The add-on author must notify server-side admins or reviewers
whenever channels need to be added, changed or removed.

 

Comments are appreciated.

Cheers,

Joseph

Other related posts: