3.0.0 • Published 10 months ago
@adesso-gcc/semantic-release-config v3.0.0
@adesso-gcc/semantic-release-config
Our shareable semantic-release configuration.
Plugins
This shareable configuration uses the following plugins:
@semantic-release/commit-analyzer
@semantic-release/release-notes-generator
@semantic-release/changelog
@semantic-release/npm
@semantic-release/git
@semantic-release/github
Install
$ npm install --save-dev semantic-release @adesso-gcc/semantic-release-config
Usage
The shareable config can be configured in the semantic-release configuration file:
{
"extends": "@adesso-gcc/semantic-release-config"
}
NPM Publishing
NPM Publishing is disabled by default.
If you are using this configuration for an NPM package and do intend to publish
it to a registry, make sure to not set the "private" option to true in
package.json
and to override the semantic-release npmPublish
option
with true
.
Configuration
By default, this configuration is set up for NodeJs projects on GitHub. Please locally override the plugin list for other programming languages and environments. The plugin list containing official and community plugins should be used as source.