README.md

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

In release-it config:

"plugins": {
  "@release-it/conventional-changelog": {
    "preset": "angular",
    "infile": "CHANGELOG.md"
  }
}

You can also choose a preferred scheme for versioning:

// semver.org scheme
"plugins": {
  "@release-it/conventional-changelog": {
    "preset": "angular",
    "versionScheme": "semver"
  }
}

// calver.org scheme
"plugins": {
  "@release-it/conventional-changelog": {
    "preset": "angular",
    "versionScheme": "calver",
    "versionFormat": "YY.MM.MICRO"
  }
}

• Omit the infile at will. If set, but the file does not exist yet, it's created with the full history.
• Please find the list of available presets (angular, ember, etc).
• Options are passed verbatim to conventional-recommended-bump and conventional-changelog.
• Available version schemes: semver.org and calver.org.