https://github.com/felixfbecker/semantic-release-firefox
🦊📦🚀 semantic-release plugin to automatically release Firefox extensions
https://github.com/felixfbecker/semantic-release-firefox
extension firefox mozilla semantic-release semantic-release-plugin
Last synced: 4 months ago
JSON representation
🦊📦🚀 semantic-release plugin to automatically release Firefox extensions
- Host: GitHub
- URL: https://github.com/felixfbecker/semantic-release-firefox
- Owner: felixfbecker
- License: mit
- Created: 2018-08-04T17:05:03.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-11-25T21:30:23.000Z (7 months ago)
- Last Synced: 2025-02-01T08:47:39.322Z (5 months ago)
- Topics: extension, firefox, mozilla, semantic-release, semantic-release-plugin
- Language: HTML
- Homepage:
- Size: 619 KB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# semantic-release-firefox
[](https://www.npmjs.com/package/semantic-release-firefox)
[](https://github.com/felixfbecker/semantic-release-firefox/actions)
[](https://codecov.io/gh/felixfbecker/semantic-release-firefox)
[](https://david-dm.org/felixfbecker/semantic-release-firefox)
[](https://david-dm.org/felixfbecker/semantic-release-firefox?type=peer)
[](https://github.com/prettier/prettier)
[](https://github.com/semantic-release/semantic-release)
A [`semantic-release`](https://github.com/semantic-release/semantic-release) plugin for you to be able to easily publish Firefox Extensions using it's automated release.
Will update the version in the manifest, create a `.xpi`, zip your sources and submit everything for review, including semantic release notes.
Since Mozilla does not expose an API to do fully automated extension releases, runs a headless Chrome through [Puppeteer](https://github.com/GoogleChrome/puppeteer) to upload the files through the web form.
## Plugins
### verifyConditions
Verify the presence of the authentication (set via environment variables).
### prepare
Write the correct version to the `manifest.json` and creates a `xpi` file of the whole dist folder.
- `xpiPath`: Required, the filename of the xpi file.
- `distFolder`: Required, the folder that will be zipped.
- `manifestPath`: Optional, the path of the manifest inside the dist folder. Defaults to `${distFolder}/manifest.json`.
- `sourcesGlob`: Optional, a glob pattern of source files that will be zipped and submitted for review. Defaults to all files in the cwd (`**`)
- `sourcesGlobOptions`: Optional, glob options passed to [node-glob](https://github.com/isaacs/node-glob#options). Defaults to ignore `node_modules`, `distFolder`, `xpiPath` and `sourcesArchivePath`. You can use this for example if
- you need to include dotfiles (set `{ dot: true }`)
- if you need to include certain private packages from `node_modules` (set `ignore: 'node_modules/!(privatepkg|privatepkg2)/**'`). Make sure to still exclude `sourcesArchivePath` or the plugin may get stuck in an infinite loop trying to add the archive to itself!
- `sourcesArchivePath`: Optional, the file path for the zip with the source files that will be created. Defaults to `./sources.zip`. Set this to `null` to not create a sources archive.
### publish
Uploads the generated xpi file, a zip of the sources and submits it together with release notes.
- `xpiPath`: Required, the filename of the xpi file.
- `addOnSlug`: Required, The URL slug of the extension, as in `https://addons.mozilla.org/en-US/firefox/addon/SLUG/`
- `sourcesArchivePath`: Optional, the file path for the zip with the source code that will be uploaded. Defaults to `./sources.zip`. Set this to `null` to not upload a sources archive.
- `notesToReviewer`: Optional, notes to the reviewer that will be submitted for every version. For example, you could link to the source code on GitHub.
## Configuration
### Mozilla Add-On hub authentication
The following environment variables have to be made available in your CI environment: `FIREFOX_EMAIL`, `FIREFOX_PASSWORD` and `FIREFOX_TOTP_SECRET`.
It is recommended to create a bot account for them.
The account must have 2FA set up, with the 2FA secret saved in `FIREFOX_TOTP_SECRET`.
Click on "Can't scan code?" when being shown the setup QR code to reveal the TOTP secret in plain text.
Make sure the account accepted the terms & agreements by visiting the submit page once (otherwise the release will fail).
### Release configs
Use `semantic-release-chrome` as part of `verifyConditions`, `prepare` and `publish`.
A basic config file example is available below:
```json
{
"verifyConditions": ["semantic-release-firefox", "@semantic-release/github"],
"prepare": [
{
"path": "semantic-release-firefox",
"xpiPath": "my-extension.xpi",
"distFolder": "dist"
}
],
"publish": [
{
"path": "semantic-release-firefox",
"xpiPath": "my-extension.xpi",
"addOnSlug": "my-extension"
},
{
"path": "@semantic-release/github",
"assets": [
{
"path": "my-extension.xpi"
}
]
}
]
}
```
## Development
Tests for the `publish` plugin are running against a mock AMO server written with Express.
Run them with `npm test`.