conventional-changelog-conventionalcommits

conventional-changelog-conventionalcommits

A concrete implementation of the specification described at conventionalcommits.org for automated CHANGELOG generation and version management.

Install

# pnpm
pnpm add -D conventional-changelog-conventionalcommits
# yarn
yarn add -D conventional-changelog-conventionalcommits
# npm
npm i -D conventional-changelog-conventionalcommits

Usage

Use with conventional-changelog by passing the preset name with -p:

conventional-changelog -p conventionalcommits

Or use it directly as a base preset to customize it:

import createPreset from 'conventional-changelog-conventionalcommits'

const config = createPreset({
  issuePrefixes: ['TEST-']
})
// do something with the config

Documentation

For the commit convention details and preset options, visit the documentation website.