Skip to content
This repository has been archived by the owner on Dec 12, 2022. It is now read-only.

Commit

Permalink
Fix typo, move publishing notes
Browse files Browse the repository at this point in the history
  • Loading branch information
jsantell committed Dec 14, 2019
1 parent 933539d commit b222a1b
Showing 1 changed file with 23 additions and 23 deletions.
46 changes: 23 additions & 23 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Using [web-ext](https://extensionworkshop.com/documentation/develop/getting-star

### Chrome

In [chrome://extensions], load the extension *unpacked*.
In `chrome://extensions`, load the extension *unpacked*.

A (benign) warning will appear referencing the `browser_specific_settings` key in `manifest.json` as unrecognized. Everything else works as expected.

Expand All @@ -29,6 +29,28 @@ Running locally as an unsigned extension on Firefox requires Developer Edition,

Chrome requires its own build since it does not recognize `browser_specific_settings` in the web extension manifest. Run `npm run build:dist:chrome` to create a build specifically for Chrome in `./dist`. This will then need to be packed as a `.crx` via "Pack Extension" in `chrome://extensions`.

## Publishing

Before publishing:

* Test Firefox via `web-ext run`
* Test Chrome via unpacked extension in `chrome://extensions`
* Increment the version via `npm version [major | minor | patch]`. This will update the version across `package.json`, `manifest.json` and tag and push to the git origin.

### Firefox

* `npm run build:dist` and `npm run build:source`
* Go to [Three.js Developer Tools AMO Page](https://addons.mozilla.org/en-US/developers/addon/three-js-developer-tools) and upload build `dist/three.js_developer_tools_*.zip`
* Since [@pika/web] is used to bundle dependencies, according to AMO's [source code submission policy](https://developer.mozilla.org/en-US/Add-ons/Source_Code_Submission), source code also needs to be uploaded. Upload `dist/three-devtools-source.zip`
* TODO Should add a markdown page for AMO reviewers to easily recreate builds
* Ensure minimum Firefox version is updated -- latest release version (or maybe ESR?).

### Chrome

* Build extension for Chrome: `npm run build:dist:chrome`
* Go to [Chrome's Developer Dashboard](https://chrome.google.com/webstore/developer/dashboard) and *edit* the Three.js Developer Tools entry, and upload `dist/three.js_developer_tools_*.zip`
* Accept the review notice that it'll take some time due to the broad permissions.

## Technology & Background

Devtools extensions run in several different processes and communicating between content, background scripts and devtools pages requires some plumbing. See [Extending DevTools](https://developer.chrome.com/extensions/devtools) for more details.
Expand Down Expand Up @@ -147,28 +169,6 @@ There are a few options to handle this.
* Less inspectable than a singleton
* Moves code from injected code to content script code -- could the extra content script be lazily brought in on first sign of a post message?

## Publishing

Before publishing:

* Test Firefox via `web-ext run`
* Test Chrome via unpacked extension in `chrome://extensions`
* Increment the version via `npm version [major | minor | patch]`. This will update the version across `package.json`, `manifest.json` and tag and push to the git origin.

### Firefox

* `npm run build:dist` and `npm run build:source`
* Go to [Three.js Developer Tools AMO Page](https://addons.mozilla.org/en-US/developers/addon/three-js-developer-tools) and upload build `dist/three.js_developer_tools_*.zip`
* Since [@pika/web] is used to bundle dependencies, according to AMO's [source code submission policy](https://developer.mozilla.org/en-US/Add-ons/Source_Code_Submission), source code also needs to be uploaded. Upload `dist/three-devtools-source.zip`
* TODO Should add a markdown page for AMO reviewers to easily recreate builds
* Ensure minimum Firefox version is updated -- latest release version (or maybe ESR?).

### Chrome

* Build extension for Chrome: `npm run build:dist:chrome`
* Go to [Chrome's Developer Dashboard](https://chrome.google.com/webstore/developer/dashboard) and *edit* the Three.js Developer Tools entry, and upload `dist/three.js_developer_tools_*.zip`
* Accept the review notice that it'll take some time due to the broad permissions.

[@pika/web]: https://github.com/pikapkg/web
[LitElement]: https://lit-element.polymer-project.org
[web components]: https://developer.mozilla.org/en-US/docs/Web/Web_Components

0 comments on commit b222a1b

Please sign in to comment.