Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.4 KB

README.md

File metadata and controls

34 lines (22 loc) · 1.4 KB

lifeway-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

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.

Usage

  1. Install npm-github-release
npm i --save-dev lifeway/npm-github-release
  1. Add a new release script to your package.json file
"scripts": {
  "release": "npm-github-release"
}
  1. Run npm run release.

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.

Credits

Thanks to Brady Holt for his intitial module, npm-github-release. This version does not publish to npm and serves as a fork-and-customized repo for LifeWay.