Skip to content

GitHub action for publishing extension to Firefox Add-on

License

Notifications You must be signed in to change notification settings

wdzeng/firefox-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

Firefox Addon

version license

This action publishes your Firefox add-on to Firefox Addons using the addons.mozilla.org API v5.

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

Prerequisites

Followings items are required before publishing an add-on:

  • An xpi (zip) file to be uploaded.
  • A JWT issuer and secret. If you do not have a JWT issuer or secret, go here to generate an API credential.

Usage

  • addon-guid: (required) add-on's GUID; this value should be the value at browser_specific_settings.gecko.id in manifest.json; it may be an email or something like {xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx}.
  • jwt-issuer: (required) your jwt issuer.
  • jwt-secret: (required) your jwt secret.
  • xpi-path: (required) path (or a glob pattern) to the xpi (zip) file of your add-on generated in the previous workflow steps; must end with either .zip, .xpi, or .crx; if glob pattern then it must match exactly one file.
  • approval-notes: (optional): a secret text to Mozilla reviewers.
  • license: (optional) add-on's license slug.
  • self-hosted (optional) whether the add-on should be self-hosted; default false.
  • source-file-path (optional) path (or a glob pattern) to source code archive; must end with either .zip, .tar.gz, .tgz or .tar.bz2; if glob pattern then it must match exactly one file.

Example workflow:

steps:
  - uses: wdzeng/firefox-addon@v1
    with:
      addon-guid: your-addon's-guid
      xpi-path: your-addon.zip
      self-hosted: false
      jwt-issuer: ${{ secrets.FIREFOX_JWT_ISSUER }}
      jwt-secret: ${{ secrets.FIREFOX_JWT_SECRET }}

References

Sister Actions