npm-github-release
v0.13.0
Published
Automates the full release process for npm packages
Downloads
4,543
Maintainers
Readme
npm-github-release
Automate the full release process for npm packages.
When publishing npm packages, there is more to do than just running npm package
. Usually, you end up doing the following steps:
- Versioning
- Creating a release on GitHub with release notes
- Publishing to npm
npm-github-release automates these steps in a simple way. Simply run npm run release
, specify the release type (major, minor, patch), provide release notes and you are done. After npm-github-release finishes, you will have a new version of your package available on npm as well as a corresponding release on GitHub with release notes.
Only macOS and Linux are supported.
Usage
- Install npm-github-release
npm i --save-dev npm-github-release
- Add a new
release
script to yourpackage.json
file
"scripts": {
"release": "npm-github-release"
}
- Run
npm run release
.
Demo
Settings
A GitHub Personal access token will be needed to create the release on GitHub. Adding this token to an environment variable named GITHUB_API_TOKEN
is recommended as this will allow npm-github-release to skip prompting for it.