Validate NVDA add-on metadata

This is a "GitHub Action" repository. The Action aims to validate the metadata of add-ons submitted to NVDA's add-on store.

• Check that the added metadata:
  • Conforms with the addonVersion_schema.json file.
  • File has the correct path and name: addon1/majorVersion.minorVersion.patch.json
  • Download URL is valid:
    • Must start with "https://" and end with".nvda-addon"
    • The *.nvda-addon file can be downloaded
  • The Sha256 of the downloaded *.nvda-addon file matches.
• Check data matches the addon's manifest file.
  • The manifest exists in the downloaded *.nvda-addon file and can be loaded by the AddonManifest class.
  • The submission addonName matches the manifest summary field
  • The submission description matches the manifest description field
  • The homepage URL matches the manifest URL field
  • The addon versions match
  • The last tested & minimum required versions are valid NVDA API versions.

If all is valid, "Congratulations: manifest, metadata and file path are valid" is printed.

Dependencies

• Python.
• Tested with: 3.13, 64 bit

Local Usage

To try validating an addon submission on your own machine.

From cmd.exe:

1. Clone this repo: git clone https://github.com/nvaccess/addon-datastore-validation.git
2. From the repo folder, run: runvalidate <pathToAddonMetadataFile.json> <pathToFileWithAPIVersions.json>

Run unit tests

To test the scripts used in this action, you can run the unit tests.

1. Install uv

Python linting

To keep a consistent style within the Python files of this Action, linting is used:

1. Use cmd.exe
2. cd to the repo folder
3. runlint

Calculate a hash (sha256)

To get the sha256 of a file:

1. Use cmd.exe
2. runsha <path\to\filename>