Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iorate/semantic-release-amo
A semantic-release plugin to publish Firefox add-ons to AMO (addons.mozilla.org).
https://github.com/iorate/semantic-release-amo
add-on amo firefox semantic-release
Last synced: about 2 months ago
JSON representation
A semantic-release plugin to publish Firefox add-ons to AMO (addons.mozilla.org).
- Host: GitHub
- URL: https://github.com/iorate/semantic-release-amo
- Owner: iorate
- License: mit
- Created: 2023-01-04T14:48:13.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-06T11:51:14.000Z (8 months ago)
- Last Synced: 2024-08-08T23:45:00.366Z (5 months ago)
- Topics: add-on, amo, firefox, semantic-release
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/semantic-release-amo
- Size: 2.46 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# semantic-release-amo
A semantic-release plugin to publish Firefox add-ons to AMO (addons.mozilla.org).
## Motivation
[semantic-release-firefox-add-on](https://github.com/tophat/semantic-release-firefox-add-on) is a great plugin to publish Firefox add-ons to AMO. However, it does not support submitting source code.
This plugin makes it possible to submit source code by using
[API V5](https://addons-server.readthedocs.io/en/latest/topics/api/addons.html#version-sources).
## Usage
```json
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
[
"semantic-release-amo",
{
"addonId": "my-addon-id",
"addonDirPath": "dist",
"approvalNotes": "To build this add-on, please run `yarn && yarn build`",
"submitSource": true
}
]
]
}
```
## Steps
| Step | Description |
| ------------------ | ------------------------------------------------- |
| `verifyConditions` | Verify the environment variables and the options. |
| `prepare` | Update `manifest.json` and archive the add-on. |
| `publish` | Publish the add-on to AMO. |
## Environment variables
| Variable | Description |
| ---------------- | --------------------------------------------------------------- |
| `AMO_API_KEY` | **REQUIRED** The API key to publish the add-on to AMO. |
| `AMO_API_SECRET` | **REQUIRED** The API secret to publish the add-on to AMO. |
| `AMO_BASE_URL` | The base URL of AMO. Defaults to `https://addons.mozilla.org/`. |
## Options
| Option | Description |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `addonId` | **REQUIRED** The id of the add-on. Can be either a slug or a GUID. |
| `addonDirPath` | **REQUIRED** The path of the directory containing the add-on. |
| `addonZipPath` | The path of the zip file to archive the add-on. Defaults to `"./semantic-release-amo/${nextRelease.version}.zip"`. |
| `channel` | The channel to publish the add-on. Can be either `"listed"` or `"unlisted"`. Defaults to `"listed"`. |
| `approvalNotes` | The notes for the Mozilla reviewers. |
| `compatibility` | The applications that the add-on is compatible with. Can be an array of `"firefox"` or `"android"`. Defaults to `["firefox"]`. |
| `submitReleaseNotes` | Whether to submit the release notes typically generated by `@semantic-release/release-notes-generator`. Defaults to `false`. |
| `submitSource` | Whether to submit the source code archived by `git archive`. Defaults to `false`. |
## Exported function
### updateAddon
```typescript
import { updateAddon } from 'semantic-release-amo/update-addon';
await updateAddon({
apiKey: '...',
apiSecret: '...',
baseURL: 'https://addons.mozilla.org/', // optional, defaults to 'https://addons.mozilla.org/'
addonId: '...',
addonZipPath: await generateAddonZip(),
channel: 'listed', // optional, defaults to 'listed'
approvalNotes: '...', // optional
compatibility: ['firefox'], // optional, defaults to ['firefox']
releaseNotes: '...', // optional
sourceZipPath: await generateSourceZip(), // optional
logger: console, // optional, defaults to console
});
```
## Author
[iorate](https://github.com/iorate) ([Twitter](https://twitter.com/iorate))
## License
semantic-release-amo is licensed under [MIT License](LICENSE.txt).