Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 1.51 KB

README.md

File metadata and controls

50 lines (35 loc) · 1.51 KB
Raw

release-it-changelogen

unjs/changelogen powered versioning and changelog generation plugin for Release It!

This plugin adds the following with Release It!

  • Enables semantic versioning (semver) and changelog generation,powered by unjs/changelogen
  • Enables dotenv integration automatically; no need to configure it separately

Installation

npm install -D release-it-changelogen

In release-it config:

You also need to set git tag and commit messages to match semver. Currently, Release It plugins cannot update other plugin's options Issue

plugins: {
  'release-it-changelogen': {
    disableVersion: true
    templates: {
      commitMessage: "chore(release): v{{newVersion}}",
      tagMessage: "v{{newVersion}}",
      tagBody: "v{{newVersion}}",
    }
  },
  git: {
    tagName: 'v${version}',
    commitMessage: 'chore(release): v${version}',
    tagAnnotation: 'v${version}',
  },
}

Configuration Options

disableVersion

Disables the recommended version provided by Changelogen

bypassConfirm

Skips the version confirmation prompt and always uses the version provided by Changelogen

All Other Options

Are passed to Changelogen; More information on available options can be found here: changelogen