rainbow-me / bpp

🚀 Browser Platform Publisher

Browser Platform Publisher

A GitHub action from Plasmo to publish your browser extension to every web store/add-ons marketplace. This action and its dependencies are open-sourced under the MIT license. The core modules are:

• Browser Market Submit
• Chrome Webstore API
• Mozilla Addons API
• Edge Addons API

Usage

First, create a keys.json in your favorite text editor (preferably one that supports json-schema):

{
  "$schema": "https://raw.githubusercontent.com/PlasmoHQ/bpp/v3/keys.schema.json"
}

A sample template is provided in keys.template.json, and the JSON schema is in keys.schema.json. If your editor supports json-schema, it should give you intellisense/autocompletion while working on the keys.

NOTE: You should only specify the browser you wish to publish to. If there are any invalid configuration, the action will fail! I.e, no empty key allowed such as "chrome": {}.

Copy the content of your keys.json into a github secret with a name of your choosing, in this case we used BPP_KEYS. Then, the action can be used as follows:

steps:
  - name: Browser Platform Publish
    uses: PlasmoHQ/bpp@v3
    with:
      keys: ${{ secrets.BPP_KEYS }}

NOTE: If you skipped the zip parameter in your keys, and your extension artifact is understood by the browser you specified, you can declare an artifact action parameter:

steps:
  - name: Browser Platform Publish
    uses: PlasmoHQ/bpp@v3
    with:
      artifact: build/artifact.zip
      keys: ${{ secrets.BPP_KEYS }}

This works if you're targeting a group of browsers that share a similar format, such as Chrome or Edge.

Support

Join the Discord channel!

License

MIT ⭐ Plasmo Corp.