1.0.5 • Published 2 years ago
@linx-digital/semantic-release-npm-github-config v1.0.5
@linx-digital/semantic-release-npm-github-config
semantic-release shareable config to publish npm packages with GitHub.
Plugins
This shareable configuration uses the following plugins:
@semantic-release/commit-analyzer@semantic-release/release-notes-generator@semantic-release/npm@semantic-release/exec@semantic-release/git
Summary
- Provides an informative git commit message for the release commit that does not trigger continuous integration and conforms to the conventional commits specification (e.g., "chore(release): 1.2.3 skip ci\n\nnotes").
- Creates a tarball that gets uploaded with each GitHub release.
- Publishes the same tarball to npm.
- Commits the version change in
package.json. - Creates or updates a changelog file.
Install
$ npm install --save-dev semantic-release @linx-digital/semantic-release-npm-github-configUsage
The shareable config can be configured in the semantic-release configuration file:
{
"extends": "@linx-digital/semantic-release-npm-github-config",
"branch": "master"
}Configuration
Ensure that your CI configuration has the following secret environment variables set:
See each plugin documentation for required installation and configuration steps.