Semantic-release shareable config for releasing atom packages with apm.
$ npm install --save-dev semantic-release @semantic-release/apm-config
In package.json
:
{
"release": {
"extends": "@semantic-release/apm-config"
}
}
$ npm install -g semantic-release @semantic-release/apm-config
$ semantic-release -e @semantic-release/apm-config
The apm
command line has to be installed in your CI environment and available in the PATH
.
See the Atom Package CI Scripts documentation.
Note: If you are running multiple versions of Atom in CI (Stable + Beta),
ensure that the semantic-release
command is run on a build using the Stable
channel of Atom as the Beta channel builds only provide apm-beta
. If you are
using travis-deploy-once
this can be achieved by setting the Stable channel build to be the last build
to run, or by using the
buildLeaderId
option.
The Atom authentication configuration is required and can be set via environment variables.
Visit your account page on Atom.io to obtain your authentication token. The token has to be made available in your CI environment via the ATOM_ACCESS_TOKEN
environment variable.
The GitHub authentication configuration is required and can be set via environment variables.
Variable | Description |
---|---|
GH_TOKEN or GITHUB_TOKEN |
Required. The token used to authenticate with GitHub repository. |
ATOM_ACCESS_TOKEN |
Required. The token used to authenticate with Atom registry. |
This shareable config uses the @semantic-release/git
, @semantic-release/npm
, @semantic-release/exec
, @semantic-release/changelog
and @semantic-release/github
plugins. See the documentation of each plugins for additional options.
Options can be set in the Semantic-release configuration.
For example to change the commit message:
{
"release": {
"extends": "@semantic-release/apm-config",
"message": "chore: prepare %s release ${nextRelease.version} [skip ci]"
}
}