@oriflame/semantic-release-config/README.md

Semantic release config used inside Oriflame and mainly focused on azure DevOps. With conventional [**Oriflame changelog**](../conventional-changelog).

# @oriflame/semantic-release-config

Semantic release config used inside Oriflame and mainly focused on azure DevOps.
With conventional [**Oriflame changelog**](../conventional-changelog).

[**semantic-release**](https://github.com/semantic-release/semantic-release) shareable config to publish npm packages with [GitHub](https://github.com).

## Plugins used

This [shareable configuration](https://github.com/jedmao/semantic-release-npm-github-config/blob/master/.releaserc.json) uses the following plugins:

- [`@semantic-release/commit-analyzer`](https://github.com/semantic-release/commit-analyzer)
- [`@semantic-release/release-notes-generator`](https://github.com/semantic-release/release-notes-generator)
- [`@semantic-release/changelog`](https://github.com/semantic-release/changelog)
- [`@semantic-release/npm`](https://github.com/semantic-release/npm)
- [`@semantic-release/git`](https://github.com/semantic-release/git)

## Install

```bash
npm install --save-dev semantic-release @oriflame/semantic-release-config
```

## Usage

The shareable config can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):

```json
{
  "extends": "@oriflame/semantic-release-config",
  "branch": "master"
}
```

## Generating changelog

To enable changelog generation set env variable `GENERATE_CHANGELOG` to true;