gb-node-release

Simple NPM package for creating github releases

Usage no npm install needed!

<script type="module">
  import gbNodeRelease from 'https://cdn.skypack.dev/gb-node-release';
</script>

README

Codacy Badge

gb-node-release

Simple NPM package for creating github releases

npm install -g gb-node-release

Within the a given node project, run:

release minor

Requires that you set environment variables for github user, and API key:

export GITHUB_USER=<user>
export GITHUB_CODE=<api key>

It will increment the version in package.json, as well as any matching version numbers specified within files listed in versionInFiles in the optional configuration yaml .gb-release.yml.

github:                             # Specify the env vars to find credentials
  usernameEnvVar: GITHUB_USER
  codeEnvVar: GITHUB_CODE
versionInFiles:
  - containingCurrentVersion.txt    # Replace version numbers in these files
npmPublish: false                   # Publish after release. Defaults to false