release-notes-generator
semantic-release plugin to generate changelog content with conventional-changelog
![Greenkeeper badge](https://badges.greenkeeper.io/semantic-release/release-notes-generator.svg)
![npm next version](https://img.shields.io/npm/v/@semantic-release/release-notes-generator/next.svg)
Step | Description |
---|
generateNotes | Generate release notes for the commits added since the last release with conventional-changelog. |
Install
$ npm install @semantic-release/release-notes-generator -D
Usage
The plugin can be configured in the semantic-release configuration file:
{
"plugins": [
["semantic-release/commit-analyzer", {
"preset": "angular",
"parserOpts": {
"noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
},
}],
["semantic-release/release-notes-generator", {
"preset": "angular",
"parserOpts": {
"noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
},
"writerOpts": {
"commitsSort": ["subject", "scope"],
}
}]
]
}
With this example:
- the commits that contains
BREAKING CHANGE
, BREAKING CHANGES
or BREAKING
in their body will be considered breaking changes (by default the angular preset checks only for BREAKING CHANGE
and BREAKING CHANGES
) - the commits will be sorted in the changelog by
subject
then scope
(by default the angular preset sort the commits in the changelog by scope
then subject
)
Configuration
Options
Notes: in order to use a preset
it must be installed (for example to use the eslint preset you must install it with npm install conventional-changelog-eslint -D
)
Note: config
will be overwritten by the values of preset
. You should use either preset
or config
, but not both.
Note: Individual properties of parserOpts
and writerOpts
will override ones loaded with an explicitly set preset
or config
. If preset
or config
are not set, only the properties set in parserOpts
and writerOpts
will be used.