@auto-it/conventional-commits
TypeScript icon, indicating that this package has built-in type declarations

11.1.1 • Public • Published

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
# or
yarn add -D @auto-it/conventional-commits

Usage

{
  "plugins": [
    "npm",
    "conventional-commits"
    // other plugins
  ]
}

Options

preset

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" }]
    // other plugins
  ]
}

defaultReleaseType

The default release type to apply when the conventional commit isn't "fix", "feat" or "breaking" (ex: "chore:"). Defaults to skip.

{
  "plugins": [
    "npm",
    ["conventional-commits", { "defaultReleaseType": "patch" }]
    // other plugins
  ]
}

Package Sidebar

Install

npm i @auto-it/conventional-commits

Weekly Downloads

21,729

Version

11.1.1

License

MIT

Unpacked Size

23.7 kB

Total Files

7

Last publish

Collaborators

  • alisowski