package
Generate a changelog from git metadata.
npm install conventional-changelogGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Estimated unpacked size across 16 packages.
646.5 kB
Includes dependencies.
8 direct dependencies.
Generate a changelog from git metadata.
[!NOTE] You don't have to use the angular commit convention. For the best result of the tool to tokenize your commit and produce flexible output, it's recommended to use a commit convention.
Install conventional-changelog along with the preset you want to use, for example angular:
# pnpm
pnpm add conventional-changelog conventional-changelog-angular
# yarn
yarn add conventional-changelog conventional-changelog-angular
# npm
npm i conventional-changelog conventional-changelog-angularPass the preset name with -p:
conventional-changelog -p angularThis will not overwrite any previous changelogs. The above generates a changelog based on commits since the last semver tag that matches the pattern of "Feature", "Fix", "Performance Improvement" or "Breaking Changes".
All available command line parameters can be listed using CLI: conventional-changelog --help.
JS API is also available:
import { ConventionalChangelog } from 'conventional-changelog'
const generator = new ConventionalChangelog()
.readPackage()
.loadPreset('angular')
generator
.writeStream()
.pipe(process.stdout)For comprehensive guides, CLI options, and API reference, visit the documentation website.
MIT
oss-bot
bencoe+oss-bot@gmail.com