@hexonet/semantic-release-github-npm-config
![npm version](https://img.shields.io/npm/v/@hexonet/semantic-release-github-npm-config/latest.svg?style=popout-square&logo=npm)
semantic-release shareable config for publishing on github GitHub and npm.
Plugins
This shareable configuration uses the following plugins:
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 or updates a changelog file that gets included in the release commit.
- Creates a new GitHub release
- Publishs on npm
Install
$ npm i -D semantic-release @hexonet/semantic-release-github-npm-config
Usage
The shareable config can be configured in the semantic-release configuration file:
{
"extends": "@hexonet/semantic-release-github-npm-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.