-
Notifications
You must be signed in to change notification settings - Fork 148
Add instructions on finding the ID of an existing extension #2237
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
base: master
Are you sure you want to change the base?
Conversation
rebloor
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Rob--W left some suggestions for your consideration
|
|
||
| See [`browser_specific_settings` in manifest.json](https://developer.mozilla.org/Add-ons/WebExtensions/manifest.json/browser_specific_settings) for the syntax of setting the extension ID. | ||
|
|
||
| To find the ID for an extension that has already been published, install your existing extension from AMO, visit `about:debugging` and look at the `Extension ID` field of your extension. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| To find the ID for an extension that has already been published, install your existing extension from AMO, visit `about:debugging` and look at the `Extension ID` field of your extension. | |
| To find a published extension's ID, install the extension from AMO, visit `about:debugging`, and check the **Extension ID** field. |
|
|
||
| When you have finished developing the extension, you can [package it and submit it to AMO for review and signing](/documentation/publish/signing-and-distribution-overview/). If the packaged extension you upload does not contain an ID, AMO generates one. It's only at this point that the add-on is assigned a permanent ID, which is embedded in the signed packaged extension. | ||
|
|
||
| This ID is shown as `Extension ID` at `about:debugging` after the add-on is installed. This ID is the same for all users of the add-on. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| This ID is shown as `Extension ID` at `about:debugging` after the add-on is installed. This ID is the same for all users of the add-on. | |
| After the add-on is installed, the ID is shown in the `about:debugging` **Extension ID** field. This ID is the same for all users of the add-on. |
|
|
||
| However, if you use [AMO's API](https://addons-server.readthedocs.io/en/latest/topics/api/v4_frozen/signing.html) to upload an update to a Manifest V2 extension that doesn't define the ID in its manifest.json file you must include the add-on's ID in the request. | ||
|
|
||
| And if you update your extension to use Manifest Version 3, [the add-on ID must be set](#how-do-i-set-an-add-on-id). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| And if you update your extension to use Manifest Version 3, [the add-on ID must be set](#how-do-i-set-an-add-on-id). | |
| And, if you update your extension to use Manifest Version 3, [the add-on ID must be set](#how-do-i-set-an-add-on-id). |
|
There must be a better way to view the ID on AMO, and not naving to reside to a personal website or installing the add-on. Can we start exposing this on the AMO listing page? Maybe we can also have a dedicated section on this page, rather than repeating the same information several times. That section could also include to open the manifest file and inspect |
|
@uncenter Yes, in this specific case UUID and Add-on ID are the same. Sometimes we also call it GUID. It's confusing, I know. To add even more to that, Firefox also has an install-specific UUID that is exposed on about:debugging. We should probably rename that field in devhub to "Add-on ID", as that is the term we are using publicly. @Rob--W could you file an issue on https://github.com/mozilla/addons/ to ask that we show the add-on ID in the "More information" section on the listing page? @uncenter raises a good point. Developers generally know how to look up their ID or at least can access it through that devhub field. This documentation might be used by users or developers who don't own the particular add-on they want to look up the ID for, for example to find the listing page, or to report it to Mozilla. |
Done: mozilla/addons#16011 I will wait a little bit with updating this PR, say 1-2 weeks, to see if the feature request can be addressed quickly. If so, then the instruction on getting the ID would be much better than "install the extension". I don't really want to recommend installing the extension to know the extension ID if possible. While it may be acceptable for self-developed extensions, it is a bad practice for arbitrary third-party extensions. |

This PR adds instructions on finding the ID of an existing extension.
Note that the instructions include "install" as part of the workflow. This is acceptable for workflows where one wants to update their own extension. I can imagine scenarios where one does not want or cannot install the previous version of the extension. In that case, they could visit https://robwu.nl/crxviewer/ , specify the URL of the extension (or select the xpi file in the file chooser), then click on
manifest.jsonin the sidebar, then click on theShow analysisbutton to reveal theExtension IDfield.It also fixes a few minor issues:
]instead of)to close[...](...)However,from a sentence that did not describe an opposing statement.