@flaivour/releaser

Releaser

CLI tool to create changelogs and releases 🤖

About

Releaser is a command-line utility for organizing your changelog file that lists changes between application versions. It is intended to NPM based projects, and respects keepachangelog format.

Installation

npm i --save-dev @flaivour/releaser

You may define the following commands:

// package.json
"scripts" : {
  "release": "releaser release",
  "changelog": "releaser changelog",
}

Commands

• changelog [options] : Create changelog entry
• release [options] : Parse changelog entries and create new release

You may use --help argument for more informations about usage and available flags.

changelog

It creates a new changelog file at changelogs/<branch>.json describing the changes made by the current branch. Some questions will be asked for this purpose if the command is called without parameters.

release

It retrieves files in changelogs to create a new release entry in CHANGELOG.md. This new version is computed by incrementing the one defined in package.json in a choosen way. Some questions will be asked for this purpose if the command is called without parameters.

Licence

This is released under the MIT License.