wdzeng / edge-addon

GitHub Action for publishing extension to Microsoft Edge Add-on!

Edge Addon

This action publishes your Edge add-on onto Microsoft Edge Add-ons using the Microsoft Edge Add-ons API v1.

This action can only publish new version of an existing add-on. Publishing a new add-on is not supported.

Prerequisites

Following items are required before publishing your Edge add-on:

• A zip file to be uploaded.
• An API client ID and secret.
• An access token url.

Please refer to this tutorial for how to generate API keys and discover access token url.

Usage

Unless noted with a default value, all options are required.

• product-id: the id of your add-on.
• zip-path: path to the zip file to be uploaded.
• client-id: your API client ID.
• client-secret: your API client secret.
• access-token-url: your access token URL.
• upload-only: (boolean) true indicates this extension will be uploaded without publishing (you'll have to publish it manually); default to false.
• check-credentials-only : (boolean) only test if given credentials are working; do not upload or publish the extension; enabling this option will ignore product-id, zip-path, and upload-only and make these options optional; default to false.

Example:

steps:
  - uses: wdzeng/edge-addon@v1
    with:
      product-id: your-addon-product-id
      zip-path: your-addon.zip
      client-id: ${{ secrets.EDGE_CLIENT_ID }}
      client-secret: ${{ secrets.EDGE_CLIENT_SECRET }}
      access-token-url: ${{ secrets.EDGE_ACCESS_TOKEN_URL }}

References

• Using the Microsoft Edge Add-ons API
• Microsoft Edge Add-ons API

Sister Actions

• Chrome Extension Action
• Firefox Add-on Action