Generate changelogs with a single command
JavaScript
Latest commit d879899 Sep 18, 2017 @leo leo 2.4.0

readme.md

Build Status XO code style Slack Channel

When run, this command line interface automatically generates a new GitHub Release and populates it with the changes (commits) made since the last release.

Usage

Install the package from npm (you'll need at least Node.js 7.6.0):

npm install -g release

Run this command inside your terminal (in your project's directory):

release

You can find an example of how to prepare a release in your project here.

Incrementing Version Tags

To bump the version inside package.json or package-lock.json, run this command (npm version is similar to this but will prefix version tags with "v"):

release <major|minor|patch>

Options

The following command will show you a list of all available options:

release help

Change Types

Each commit can be assigned a certain type of change. Here's the full list.

Why?

As we at ZEIT moved all of our GitHub repositories from keeping a HISTORY.md file to using GitHub Releases, we needed a way to automatically generate these releases from our own devices, rather than always having to open a page in the browser and manually add the notes for each change.

Contributing

You can find the authentication flow here.

  1. Fork this repository to your own GitHub account and then clone it to your local device
  2. Uninstall the package if it's already installed: npm uninstall -g release
  3. Link the package to the global module directory: npm link
  4. You can now use release on the command line!

As always, you can use npm test to run the tests and see if your changes have broken anything.

Credits

Thanks a lot to Daniel Chatfield for donating the "release" name on npm and my lovely team for telling me about their needs and how I can make this package as efficient as possible.

Author

Leo Lamprecht (@notquiteleo) - ▲ZEIT