Release:一个命令行工具,能够自动管理 GitHub 上的发布版本
Release:一个命令行工具,能够自动管理 GitHub 上的发布版本
Node.js 命令行实用程序
共2987Star
详细介绍
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.
- 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:
npm link
- 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
-
3459 Star
-
97 Star
-
0 Star
-
14752 Star
-
56 Star
-
404 Star
-
50 Star
-
2 Star
-
14 Star
-
157 Star