Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

release-it-lerna-changelog

Package Overview
Dependencies
Maintainers
2
Versions
16
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

release-it-lerna-changelog

release-it plugin for lerna-changelog

  • 5.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
6.9K
decreased by-27.35%
Maintainers
2
Weekly downloads
 
Created
Source

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",
        "launchEditor": true
      }
    }
  }
}

The two options that release-it-lerna-changelog is aware of are:

infile

infile represents the file to prepend the generated changelog into.

launchEditor

When specified, release-it-lerna-changelog will generate the changelog then launch the configured editor with a temporary file. This allows the person doing the release to customize the changelog before continuing.

There are a few valid values for launchEditor:

  • false - Disables the feature.
  • true - If present the process.env.EDITOR value will be used as the command to invoke, if process.env.EDITOR is not found process.env.PATH will be searched for a command named editor (which is commonly used on Debian / Ubuntu systems to point to the currently configured editor). The temporary file for editing is added as an argument (i.e. $EDITOR /some/tmp/file).
  • any string - This string will be used as if it were a command. In order to interpolate the temporary file path in the string, you can use ${file} in your configuration.

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

License

This project is licensed under the MIT License.

Keywords

FAQs

Package last updated on 20 Jul 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc