release-it-bump-keepachangelog

This package is a release-it plugin (using release-it's plugin API) that integrates release-it-bump-keepachangelog into the release-it pipeline.

Usage

Installation using your projects normal package manager, for example:

# npm
npm install --save-dev @semabit/release-it-bump-keepachangelog

# yarn
yarn add --dev @semabit/release-it-bump-keepachangelog

Once installed, configure release-it to use the plugin.

Either via package.json:

{
  "release-it": {
    "plugins": {
      "@semabit/release-it-bump-keepachangelog": {}
    }
  }
}

Or via .release-it.json:

{
  "plugins": {
    "@semabit/release-it-bump-keepachangelog": {}
  }
}

Configuration

release-it-bump-keepachangelog supports one configuration option, file. When specified, this option represents the file name to prepend changelog information to during a release.

For example, given the following configuration (in package.json):

{
  "release-it": {
    "plugins": {
      "@semabit/release-it-bump-keepachangelog": {
        "file": "CHANGELOG.md"
      }
    }
  }
}

Each release will run release-it-bump-keepachangelog and updates the CHANGELOG.md.