conventional-changelog-conventionalcommits
v8.0.0
Published
Conventionalcommits.org preset for conventional-changelog.
Downloads
19,363,361
Readme
conventional-changelog-conventionalcommits
A concrete implementation of the specification described at conventionalcommits.org for automated CHANGELOG generation and version management.
Install
# yarn
yarn add -D conventional-changelog-conventionalcommits
# pnpm
pnpm add -D conventional-changelog-conventionalcommits
# npm
npm i -D conventional-changelog-conventionalcommits
Indirect Usage (as preset)
Use the Conventional Changelog CLI Quick Start with the -p conventionalcommits
option.
Direct Usage (as a base preset so you can customize it)
If you want to use this package directly and pass options, you can use the Conventional Changelog CLI Quick Start and with the --config
or -n
parameter, pass a js config that looks like this:
import createPreset from 'conventional-changelog-conventionalcommits'
createPreset({
issuePrefixes: ['TEST-'],
issueUrlFormat: 'https://myBugTracker.com/{{prefix}}{{id}}'
}).then((config) => {
// do something with the config
})
or json config like that:
{
"options": {
"preset": {
"name": "conventionalchangelog",
"issuePrefixes": ["TEST-"],
"issueUrlFormat": "https://myBugTracker.com/{{prefix}}{{id}}"
}
}
}
This last json config way passes the preset
object to the conventional-changelog-preset-loader
package, that in turn, passes this same preset
object as the config for the conventional-changelog-conventionalcommits
.
See conventional-changelog-config-spec for available configuration options.