Socket
Socket
Sign inDemoInstall

npm-github-release

Package Overview
Dependencies
85
Maintainers
1
Versions
17
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    npm-github-release

Automates the full release process for npm packages


Version published
Weekly downloads
8
decreased by-38.46%
Maintainers
1
Install size
11.7 MB
Created
Weekly downloads
 

Readme

Source

npm-github-release NPM Package

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
  1. Add a new release script to your package.json file
"scripts": {
  "release": "npm-github-release"
}
  1. Run npm run release.

Demo

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.

Keywords

FAQs

Last updated on 24 Apr 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc