Skip to content

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

License

Notifications You must be signed in to change notification settings

wdzeng/edge-addon

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Edge Add-on

version license

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

Note

This action uses the latest v1.1 API. To use the deprecated v1.0 API, please change to use the @v1 action.

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

Prerequisites

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

  • A zip file to upload.
  • An API key and a client ID.

Please refer to this tutorial for how to generate an API key and a client ID.

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 upload; may include a glob pattern (only one file must match).
  • api-key: you API key.
  • client-id: your API client ID.
  • upload-only: (boolean) true indicates this extension will be uploaded without publishing (you'll have to publish it manually); default to false.
  • notes-for-certification: (optional) A secret text to Microsoft reviewers.

Example:

steps:
  - uses: wdzeng/edge-addon@v2
    with:
      product-id: your-addon-product-id
      zip-path: your-addon.zip
      api-key: ${{ secrets.API_KEY }}
      client-id: ${{ secrets.CLIENT_ID }}

References

Sister Actions