Keep-a-changelog plugin for release-it

This release-it plugin maintains your CHANGELOG.md file according to the Keep A Changelog standards.

The idea and initial implementation comes from @eMarek.

npm install --save-dev @codeeshop/keep-a-changelog-whatsnew

yarn add @codeeshop/keep-a-changelog-whatsnew

In release-it config:

1"plugins": {
2  "@codeeshop/keep-a-changelog-whatsnew": {
3    "filename": "CHANGELOG.md"
4  }
5}

Options

option	default value	description
whatsnew	'whatsnew/whatsnew-en-US'	File with whatsnew.
filename	'CHANGELOG.md'	File with changelogs.
strictLatest	true	Entry of latest version must be present in order to get correct changelog. Set this option to false if you expect latest version without logs.
addUnreleased	false	It leaves "Unreleased" title row if set to true.
keepUnreleased	false	It leaves "Unreleased" title row unchanged if set to true.
addVersionUrl	false	Links the version to the according changeset. Uses GitHub-compatible URLs by default, see other options to configure the URL format.
versionUrlFormats	See below.	Determines the version URL format when addVersionUrl is set to true. Uses GitHub-compatible URLs by default.
head	'HEAD'	The git revision the new version tag is compared to in the Unreleased URL.

versionUrlFormats

The URL formats used when addVersionUrl is set to true. Example configuration for a repository in Azure DevOps:

1"plugins": {
2  "@release-it/keep-a-changelog": {
3    "filename": "CHANGELOG.md",
4    "head": "main",
5    "addVersionUrl": true,
6    "versionUrlFormats": {
7      "repositoryUrl": "https://dev.azure.com/...",
8      "unreleasedUrl": "{repositoryUrl}/branchCompare?baseVersion=GT{tagName}&targetVersion=GB{head}",
9      "versionUrl": "{repositoryUrl}/branchCompare?baseVersion=GT{previousTag}&targetVersion=GT{tagName}",
10      "firstVersionUrl": "{repositoryUrl}?version=GT{tagName}"
11    }
12  }
13}

option	default value	description
repositoryUrl	'https://{host}/{repository}'	The format of the repository URL.
unreleasedUrl	'{repositoryUrl}/compare/{tagName}...{head}'	The format of the [unreleased] section URL.
versionUrl	'{repositoryUrl}/compare/{previousTag}...{tagName}'	The format of a release version URL.
firstVersionUrl	'{repositoryUrl}/releases/tag/{tagName}'	The format of the first release version URL, i.e. when no previous tags have been released.