@eliasnorrby/semantic-release-config

Semantic Release Config

My semantic-release config. It extends the default configuration by adding the changelog and git plugins.

⚠️ Subject to change in the future.

Setup

Using npx

Run the following command to install and configure semantic-release

npx @eliasnorrby/semantic-release-config

This will run a setup script, adding this package to devDependencies and writing the config to .releaserc.js.

--no-install

Run setup with the --no-install flag to avoid installing this package as a dependency. Your .releaserc.js will contain a sample list of plugins for you to add to instead of extending this package.

Manually

Install the package

npm i -D @eliasnorrby/semantic-release-config

and add the configuration to .releaserc.js.

.releaserc.js

module.exports = require('@eliasnorrby/semantic-release-config')

Overriding settings

Just add your overrides to .releaserc.js:

module.exports = {
  ...require('@eliasnorrby/semantic-release-config'),
  branch: 'production',
}