xchangelog (@-xun/changelog)

This conventional-changelog-core fork slightly tweaks the original to fix some bugs and bundle type definitions that are more well-formed.

Among the bugs fixed by this fork is one where conventional-changelog-core, when given a release commit with multiple tags, will only accept the first tag in the list as the version tag if it matches (i.e. starts with tagPrefix). Without this fix, when the actual matching version tag is not first in the list, strange things happen.

Multiple tags on the same release commit is useful when, for instance, you transmute a polyrepo into a monorepo and need to alias the original v${version}-style tags with the more monorepo-friendly ${package-name}@${version}-style tags.

[!NOTE]

The only reason to use xchangelog over conventional-changelog-core is if you are using an xscripts-powered project or you need the bug fixes. Otherwise, just use conventional-changelog.

Install

To install xchangelog:

npm install --save-dev @-xun/changelog

If you want to use a specific version of xchangelog, provide its semver:

npm install --save-dev @-xun/[email protected]

[!NOTE]

xchangelog installations can reuse the "conventional-changelog-core" name so that plugins with conventional-changelog-core as a peer dependency are able to recognize xchangelog's presence. For example:

npm install --save-dev conventional-changelog-core@npm:@-xun/changelog

Usage

import conventionalChangelogCore from '@-xun/changelog';

conventionalChangelogCore().pipe(process.stdout); // or any writable stream

See the conventionalChangelogCore upstream documentation for more details.

Contributing

Consider contributing to upstream conventional-changelog instead.