https://github.com/bradymholt/npm-github-release
Automates the full release process for npm packages
https://github.com/bradymholt/npm-github-release
Last synced: 7 days ago
JSON representation
Automates the full release process for npm packages
- Host: GitHub
- URL: https://github.com/bradymholt/npm-github-release
- Owner: bradymholt
- Created: 2016-08-01T20:47:54.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T16:43:37.000Z (over 2 years ago)
- Last Synced: 2025-04-16T03:55:54.719Z (10 days ago)
- Language: JavaScript
- Homepage:
- Size: 70.3 KB
- Stars: 10
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# npm-github-release [](https://www.npmjs.com/package/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
1. Install npm-github-release
```
npm i --save-dev npm-github-release
```
2. Add a new `release` script to your `package.json` file
```
"scripts": {
"release": "npm-github-release"
}
```
3. Run `npm run release`.
## Demo
## Settings
A [GitHub Personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) 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.