@digitalroute/semantic-release-config

Shared config for semantic-release for DigitalRoute

Usage

1 Install

Install this config and semantic-release as a devDependency:

npm install semantic-release @digitalroute/semantic-release-config --save-dev

2 Configure

Add the following to your package.json:

{
  "release": {
    "extends": "@digitalroute/semantic-release-config/simple"
  }
}

or the following for npm-packages that should be published to npm:

{
  "release": {
    "extends": "@digitalroute/semantic-release-config/npm"
  }
}

3 Add script

Add the following to your scripts in package.json:

"semantic-release": "semantic-release"

4 CI/CD

Add a step in your CI/CD that runs npm run semantic-release.

Configurations

npm

For publishing npm modules.

Plugins

• @semantic-release/plugin-commit-analyzer
• @semantic-release/plugin-npm
• @semantic-release-slack-bot (if SLACK_WEBHOOK is set)

Environment variables

• NPM_TOKEN: so semantic-release can publish to npm.
• SLACK_WEBHOOK: so semantic-release-slack-bot can notify slack.

simple

For keeping track of changes.

Plugins

• @semantic-release/plugin-commit-analyzer