Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add-on signing table updates #1897

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,11 @@ contributors:
wbamberg,
willdurand,
djbrown,
kirinokirino
kirinokirino,
dotproto
]
last_updated_by: kirinokirino
date: 2023-10-28
last_updated_by: dotproto
date: 2024-08-21
---

<!-- Page Hero Banner -->
Expand Down Expand Up @@ -61,7 +62,7 @@ For Manifest V2 extensions, you need to add an add-on ID when:

- You want to install an unsigned add-on from its XPI file, rather than loading it temporarily using `about:debugging`.
- You want a specific ID, rather than one randomly generated when [your extension is first signed](/documentation/publish/#get-your-extension-signed).
- You use [AMO's API](https://addons-server.readthedocs.io/en/latest/topics/api/v4_frozen/signing.html) for uploading your add-on, rather than uploading it manually on its page, you must include the add-on's ID in the request.
- You use [AMO's API](https://addons-server.readthedocs.io/en/latest/topics/api/v4_frozen/signing.html) or the [web-ext](/documentation/develop/getting-started-with-web-ext/) CLI tool when submitting updates to AMO.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this reference version 4 and 5 of the AMO API?

- You use WebExtension APIs that use the add-on ID and expect it to be the same from one browser session to the next. If you use these APIs, you must explicitly set the ID using the [`browser_specific_settings`](https://developer.mozilla.org/docs/Mozilla/Add-ons/WebExtensions/manifest.json/browser_specific_settings) key. This applies to the following APIs:
- [`storage.managed`](https://developer.mozilla.org/docs/Mozilla/Add-ons/WebExtensions/API/storage/managed "A storage.StorageArea object that represents the managed storage area. Items in managed storage are set by the domain administrator or other native applications installed on user's computer, and are read-only for the extension. Trying to modify this storage area results in an error.")
- [`storage.sync`](https://developer.mozilla.org/docs/Mozilla/Add-ons/WebExtensions/API/storage/sync 'Represents the sync storage area. Items in sync storage are synced by the browser, and are available across all instances of that browser that the user is logged into (e.g. via Firefox sync, or a Google account), across different devices.')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,11 @@ contributors:
SolidAxel,
jean-acsas,
djbrown,
thatshubham
thatshubham,
dotproto
]
last_updated_by: thatshubham
date: 2024-04-16
last_updated_by: dotproto
date: 2024-08-21
---

<!-- Page Hero Banner -->
Expand Down Expand Up @@ -75,8 +76,10 @@ Mozilla signs add-ons through [addons.mozilla.org](https://addons.mozilla.org).

| Signing method | Supported distribution channel(s) |
| ------------------------------------- | ------------------- |
| Web upload via the [AMO Developer Hub](https://addons.mozilla.org/developers/) | Public listing on AMO or self-distribution|
| Submit using [web-ext sign](https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#web-ext-sign) or using the [AMO signing API](https://addons-server.readthedocs.io/en/latest/topics/api/v4_frozen/signing.html) | Brand new submissions can only be submitted as self-distributed (unlisted) extensions. <br /><br /> Subsequent updates can be listed on AMO or self-distributed (unlisted)|
| Web upload via the [AMO Developer Hub](https://addons.mozilla.org/developers/) | Public listing on AMO or self-distribution (unlisted). |
| Upload using [`web-ext sign`](https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#web-ext-sign) | **Version 8 and higher**: Public listing on AMO or self-distribution (unlisted). <br /><br />**Version 7 and lower**: Initial submissions only provide for self-distributed (unlisted) extensions. Updates can be for extensions listed on AMO or self-distributed (unlisted). |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Upload using [`web-ext sign`](https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#web-ext-sign) | **Version 8 and higher**: Public listing on AMO or self-distribution (unlisted). <br /><br />**Version 7 and lower**: Initial submissions only provide for self-distributed (unlisted) extensions. Updates can be for extensions listed on AMO or self-distributed (unlisted). |
| Upload using [`web-ext sign`](https://extensionworkshop.com/documentation/develop/web-ext-command-reference/#web-ext-sign) | **Version 8 and higher**: Initial submission and updates for extensions listed on AMO or self-distributed (unlisted). <br /><br />**Version 7 and lower**: Initial submissions for self-distributed (unlisted) extensions. Updates for extensions listed on AMO or self-distributed (unlisted). |

| The AMO [Add-on Create API (V5)](https://mozilla.github.io/addons-server/topics/api/addons.html#create) and [Version Create API (V5)](https://mozilla.github.io/addons-server/topics/api/addons.html#version-create) | Public listing on AMO or self-distribution (unlisted). |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| The AMO [Add-on Create API (V5)](https://mozilla.github.io/addons-server/topics/api/addons.html#create) and [Version Create API (V5)](https://mozilla.github.io/addons-server/topics/api/addons.html#version-create) | Public listing on AMO or self-distribution (unlisted). |
| The AMO [Add-on Create API (V5)](https://mozilla.github.io/addons-server/topics/api/addons.html#create) and [Version Create API (V5)](https://mozilla.github.io/addons-server/topics/api/addons.html#version-create) | Initial submission and updates for extensions listed on AMO or self-distributed (unlisted). |

| The AMO [Signing API (V4)](https://addons-server.readthedocs.io/en/latest/topics/api/v4_frozen/signing.html) | Initial submissions only provide for self-distributed (unlisted) extensions. Updates can be to extensions publicly listed on AMO or self-distributed (unlisted). |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| The AMO [Signing API (V4)](https://addons-server.readthedocs.io/en/latest/topics/api/v4_frozen/signing.html) | Initial submissions only provide for self-distributed (unlisted) extensions. Updates can be to extensions publicly listed on AMO or self-distributed (unlisted). |
| The AMO [Signing API (V4)](https://addons-server.readthedocs.io/en/latest/topics/api/v4_frozen/signing.html) | Initial submissions for self-distributed (unlisted) extensions. Updates to extensions publicly listed on AMO or self-distributed (unlisted). |


{% endcapture %}
{% include modules/table.liquid,
Expand Down Expand Up @@ -112,7 +115,7 @@ For more information on how to submit an add-on for distribution on AMO or self-
### Self-distribution
Self-distributed add-ons are sometimes referred to as “unlisted” extensions because they cannot be publicly viewed or installed from AMO. You may want to self-distribute your extension if it is a beta version or if it is intended to be used by a limited audience. All add-ons, including self-distributed ones, are subject to be manually reviewed at any time after submission to check for compliance with the [Add-on Policies](/documentation/publish/add-on-policies/).

If you choose this method, be sure to read the article on [self-distribution](/documentation/publish/self-distribution/) to learn how users can install self-distributed add-ons and how to push automatic updates to your users.
If you choose this method, be sure to read the article on [self-distribution](/documentation/publish/self-distribution/) to learn how users can install self-distributed add-ons and how to push automatic updates to your users.

{% endcapture %}
{% include modules/one-column.liquid,
Expand Down
Loading