When run, this command line interface automatically generates a new GitHub Release and populates it with the changes (commits) made since the last release.
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):
You can find an example of how to prepare a release in your project here.
Incrementing Version Tags
To bump the version inside
package-lock.json, run this command (
npm version is similar to this but will prefix version tags with "v"):
The following command will show you a list of all available options:
Each commit can be assigned a certain type of change. Here's the full list.
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.
You can find the authentication flow here.
- Fork this repository to your own GitHub account and then clone it to your local device
- Uninstall the package if it's already installed:
npm uninstall -g release
- Link the package to the global module directory:
- You can now use
releaseon the command line!
As always, you can use
npm test to run the tests and see if your changes have broken anything.