Conventional Commits Plugin
Parse conventional commit messages and use them to calculate the version. This plugin will omit the PR HEAD if it isn't labeled and has a commit with a conventional-commit commit message.
The default behavior extends the conventional commits spec:
- Type
fix:
=> patch
- Type
feat:
=> minor
- Type
BREAKING:
=> major
- A
!
in the type indicated a breaking change BREAKING CHANGE
in the footer indicates a breaking change- All other types are considered
skip-release
Installation
This plugin is not included with the auto
CLI installed via NPM. To install:
npm i --save-dev @auto-it/conventional-commits
yarn add -D @auto-it/conventional-commits
Usage
{
"plugins": [
"npm",
"conventional-commits"
]
}
Options
You can use any conventional-changelog preset with this plugin.
Using a preset will completely override this plugin's default behavior with whatever the preset defines.
{
"plugins": [
"npm",
["conventional-commits", { "preset": "angular" }]
]
}