Skip to content

Latest commit

 

History

History
91 lines (62 loc) · 3.75 KB

2-releasing.md

File metadata and controls

91 lines (62 loc) · 3.75 KB
Raw

Releasing

This document will serve as a to-do: notes to implement automated releasing through the stores. Afterwards, it will be re-written to serve as documentation.

1. Chrome Web Store

Before you can begin making REST calls against the Chrome Web Store, you will need to enable the Chrome Web Store API, configure your OAuth consent screen, and retrieve your API access keys.

1.1 Initial Setup: Auth for Chrome Web Store API

  1. Follow the instructions provided on https://developer.chrome.com/docs/webstore/using-api.
  2. This should provide you with a CHROME_CLIENT_ID and a CHROME_CLIENT_SECRET. Add these to your .env. Add the CHROME_SUCCESS_CODE to your clipboard.
  3. Run the following command with your credentials
curl "https://accounts.google.com/o/oauth2/token" -d \ "client_id={{CLIENT_ID}}&client_secret={{CLIENT_SECRET}}&code={{CHROME_SUCCESS_CODE}}&grant_type=authorization_code&redirect_uri=urn:ietf:wg:oauth:2.0:oob"
  1. Store the refresh_token in .env as CHROME_REFRESH_TOKEN.
  2. Optional: If your Chrome Extension is already published, store your CHROME_EXTENSION_ID in the .env too.

You can now use the commands to add, update, publish and check the status of your Chrome Extension! 🚀

1.2 Using the Chrome Web Store API

These are the scripts available to use the Chrome Web Store API.

bun chrome:store

  • Init
    • Add your extension to the store for the first time.
    • Requires a valid build in "/dist/chrome-extension.zip".
  • Status
    • Checks the status of your extension in the store.
    • Requires a valid CHROME_EXTENSION_ID to be set in the .env.
  • Update
    • Updates your extension in the store.
    • Requires a valid build in "/dist/chrome-extension.zip" and a valid CHROME_EXTENSION_ID to be set in the .env.
  • Publish
    • Publishes your extension in the store to all users.
    • Requires a valid build in "/dist/chrome-extension.zip" and a valid CHROME_EXTENSION_ID to be set in the .env.

Requirements

  1. Requires a valid build in "/dist/chrome-extension.zip"
  2. Requires a valid CHROME_EXTENSION_ID to be set in the .env

2. Firefox Add-Ons

Before you can begin making REST calls against the Firefox Add-Ons enviromnent, you will need to generate your API access keys.

2.1 Initial Setup: Auth for Firefox Add-Ons API

  1. Follow the instructions provided on https://addons-server.readthedocs.io/en/latest/topics/api/auth.html
  2. This should provide you with a FIREFOX_JWT_ISSUER and a FIREFOX_JWT_SECRET. Add these to your .env.
  3. Randomly generate a value and store it as the FIREFOX_JWT_ID.
  4. Optional: If your Firefox Extension is already published, store your FIREFOX_EXTENSION_ID in the .env too.

You can now use the commands to add, update, publish and check the status of your Chrome Extension! 🚀

2.2 Using the Firefox Add-Ons API

These are the scripts available to use the Firefox Add-Ons API.

bun firefox:store

  • Update
    • Update your extension in the Firefox Add-Ons Store
    • Requires a valid build in "/dist/chrome-extension.zip".
  • Status
    • Checks the status of your extension in the store.
    • Requires a valid FIREFOX_EXTENSION_ID to be set in the .env.
  • Publish
    • Publishes your extension in the store to all users.
    • Requires a valid build in "/dist/chrome-extension.zip" and a valid FIREFOX_EXTENSION_ID to be set in the .env.

Requirements

  1. Requires a valid build in "/dist/chrome-extension.zip"
  2. Requires a valid CHROME_EXTENSION_ID to be set in the .env

https://addons-server.readthedocs.io/en/latest/topics/api/index.html

https://blog.mozilla.org/addons/2022/03/17/new-api-for-submitting-and-updating-add-ons/