Skip to content

Clearly describe required fields in the metadata file for web-ext sign #2286

@Rob--W

Description

@Rob--W

The metadata file is currently documented at https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/#sign-and-submit-for-publication

The docs currently state:

Metadata is required for the first version of an extension listed on AMO. This metadata can include any of the properties of the addons.mozilla.org add-on API Create request JSON object. However, the "categories" and "summary" properties must be provided.

and follows with an example. The description is incomplete, there are more fields that are required. The API docs are a bit hard to read, but the version.license must be specified as well (or version.custom_license, but not both!).

For completeness:
The "categories" field is required.
The "summary" field is not required in the metadata file, and defaults to the value of "description" in the manifest.
The "name" field is not required in the metadata file, because it defaults to the value of "name" in the manifest.json file.

Here is an example of a developer getting confused, mozilla/web-ext#3636

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions