Conventional Changelog plugin for release-it

This plugin will provide the recommended bump to release-it, and update the changelog file (e.g. CHANGELOG.md).

npm install --save-dev @release-it/conventional-changelog

Configuration

In the release-it config, for example:

1"plugins": {
2  "@release-it/conventional-changelog": {
3    "preset": {
4      "name": "angular"
5    },
6    "infile": "CHANGELOG.md"
7  }
8}

The plugin is a wrapper around conventional-changelog packages conventional-recommended-bump, conventional-changelog-core and more.

[!IMPORTANT]

For the conventionalcommits preset, you may need to override the version of the transitive conventional-changelog-conventionalcommits dependency, like so:

1{
2  "overrides": {
3    "conventional-changelog-conventionalcommits": "8.0.0"
4  }
5}

Use "resolutions" for pnpm or Yarn.

Contents

• preset
• Bump
  • commitsOpts
  • tagOpts
  • whatBump
  • ignoreRecommendedBump
  • strictSemVer
• Changelog
  • infile
  • header
  • context
  • gitRawCommitsOpts
  • parserOpts
  • writerOpts

preset

For preset.name, use one of:

• angular
• atom
• codemirror
• conventionalcommits
• ember
• eslint
• express
• jquery
• jscs
• jshint

Use an object with name and types to use a custom preset:

1"plugins": {
2  "@release-it/conventional-changelog": {
3    "infile": "CHANGELOG.md",
4    "preset": {
5      "name": "conventionalcommits",
6      "types": [
7        {
8          "type": "feat",
9          "section": "Features"
10        },
11        {
12          "type": "fix",
13          "section": "Bug Fixes"
14        },
15        {}
16      ]
17    }
18  }
19}

This is passed as the first argument to bumper.loadPreset (in both bumper and changelog writer).

See the Conventional Changelog Configuration Spec (v2.1.0) for the configuration object to pass as preset.

Bump

tagOpts

• This option will be passed as the first argument to bumper.tag
• Type definition for tagOpts → look for GetSemverTagsParams

commitsOpts

• This option will be passed as the first argument to bumper.commits
• Type definition for commitsOpts → look for GetCommitsParams

whatBump

• This option will be passed as the first argument to bumper.bump
• Type definition for whatBump → look for Preset['whatBump']
• Use false to skip releasing a new version:

1{
2  "plugins": {
3    "@release-it/conventional-changelog": {
4      "whatBump": false
5    }
6  }
7}

• Use a function to manually provide a bump:

1module.exports = {
2  plugins: {
3    '@release-it/conventional-changelog': {
4      whatBump: function () {
5        return { releaseType: '10.0.1' };
6      }
7    }
8  }
9};

ignoreRecommendedBump

Default value: false

Use true to ignore the recommended bump, and use the version provided by release-it (command line argument or prompt).

Note that the changelog preview shows the recommended bump, as the desired version isn't known yet in the release-it process. The infile will have the correct version.

strictSemVer

Default value: false

Use true to strictly follow semver, also in consecutive pre-releases. This means that from a pre-release, a recommended bump will result in a next pre-release for the next version.

For example, from 1.0.0-alpha.0 a recommended bump of minor will result in a preminor bump to 1.1.0-alpha.0.

The default behavior results in a prerelease bump to 1.0.0-alpha.1.

Changelog

infile

Default value: undefined

• Set a filename as infile to write the changelog to. If this file does not exist yet, it's created with the full history.
• When infile is not set, the changelog generated by this plugin will still be used as release notes for e.g. GitHub Releases.
• Set infile: false to disable the changelog writing (and only use the recommended bump for the next version).

header

Default value: "# Changelog"

Set the main header for the changelog document:

1{
2  "plugins": {
3    "@release-it/conventional-changelog": {
4      "infile": "CHANGELOG.md",
5      "header": "# Changelog",
6      "preset": {
7        "name": "conventionalcommits"
8      }
9    }
10  }
11}

context

Default value: undefined

This option will be passed as the second argument (context) to conventional-changelog-core, for example:

1"plugins": {
2  "@release-it/conventional-changelog": {
3    "context": {
4      "linkCompare": false
5    }
6  }
7}

gitRawCommitsOpts

Default value: undefined

Options for git-raw-commits. For example, you can use the following option to include merge commits into changelog:

1{
2  "plugins": {
3    "@release-it/conventional-changelog": {
4      "gitRawCommitsOpts": {
5        "merges": null
6      }
7    }
8  }
9}

parserOpts

• Default value: undefined
• Options for conventional-commits-parser
• This option will also be passed as the second argument to bumper.parserOptions
• Type definition for parserOpts → look for ParserOptions

For example, you can use the following option to set the merge pattern during parsing the commit message:

1{
2  "plugins": {
3    "@release-it/conventional-changelog": {
4      "parserOpts": {
5        "mergePattern": "^Merge pull request #(\\d+) from (.*)$"
6      }
7    }
8  }
9}

writerOpts

• Default value: undefined
• Options for conventional-changelog-writer
• Type definition for writerOpts → look for Options

For example, you can use the following option to group the commits by 'scope' instead of 'type' by default.

1{
2  "plugins": {
3    "@release-it/conventional-changelog": {
4      "writerOpts": {
5        "groupBy": "scope"
6      }
7    }
8  }
9}

If you want to customize the templates used to write the changelog, you can do it like in a .release-it.js file like so:

1const fs = require('fs');
2
3const commitTemplate = fs.readFileSync('commit.hbs').toString();
4
5module.exports = {
6  plugins: {
7    '@release-it/conventional-changelog': {
8      writerOpts: {
9        commitPartial: commitTemplate
10      }
11    }
12  }
13};

Command-line

Options for this plugin can be set from the command line. Some examples:

release-it --plugins.@release-it/conventional-changelog.infile=history.md
release-it --no-plugins.@release-it/conventional-changelog.infile

• Keys are separated by dots.
• Values can be negated by prefixing the key with no-.
• Arguments may need to be single-quoted (') such as --'deep.key=value' or '--deep.key=value'

Depending on your shell or OS this may differ.

GitHub Actions

When using this plugin in a GitHub Action, make sure to set fetch-depth: 0 so the history is available to determine the correct recommended bump and changelog.

Also see https://github.com/release-it/release-it/blob/master/docs/ci.md#github-actions