release-it-lerna-changelog

release-it-lerna-changelog

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

Usage

Installation using your projects normal package manager, for example:

# npm
npm install --save-dev release-it-lerna-changelog

# yarn add --dev release-it-lerna-changelog

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

Either via package.json:

{
  "release-it": {
    "plugins": {
      "release-it-lerna-changelog": {}
    }
  }
}

Or via .release-it.json:

{
  "plugins": {
    "release-it-lerna-changelog": {}
  }
}

Configuration

release-it-lerna-changelog supports one configuration option, infile. 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": {
      "release-it-lerna-changelog": {
        "infile": "CHANGELOG.md"
      }
    }
  }
}

Each release will run lerna-changelog and prepend the results into CHANGELOG.md.

License

This project is licensed under the MIT License.

Changelog

v1.0.3 (2019-05-17)

:memo: Documentation

• #4 Add keywords for discoverability (@webpro)

Committers: 1

• Lars Kappert (@webpro)