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 Usage 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 Usage 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": "conventionalcommits",
      "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.

Specific Options

| Option | Description | |--------|-------------| | ignoreCommits | Ignore commits that match the provided regex. | | types | An array of types to include in the changelog. Default value can be accessed from DEFAULT_COMMIT_TYPES export. | | bumpStrict | If set to true, the version will be bumped only if there are breaking changes or if the commit type is in the types array. Default value is false. | | scope | Scope name to filter commits. By default, commits without scope are included. | | scopeOnly | If set to true, only commits with the specified scope will be included. Default value is false. |