Skip to content

Kikobeats/github-generate-release

Repository files navigation

github-generate-release

Last version NPM Status

github-generate-release is the simplest way to create a GitHub Release.



It needs a GitHub token with public_repo permission, exposed as GH_TOKEN or GITHUB_TOKEN (see example).

Getting Started

Just call it and it will release the latest git tag created:

npx github-generate-release

That makes easy integrate it as part of a release workflow:

{
  "release": "standard-version -a",
  "postrelease": "npm run release:tags && npm run release:github && npm publish",
  "release:tags": "git push --follow-tags origin HEAD:master",
  "release:github": "github-generate-release",
}

You can pass any flag supported by GitHub API release endpoint:

npx github-generate-release --draft

Alternatively, it can be used as Node.js module:

const release = require('github-generate-release')

await release({ draft: true })

License

github-generate-release © Kiko Beats, released under the MIT License.
Authored and maintained by Kiko Beats with help from contributors.

kikobeats.com · GitHub Kiko Beats · Twitter @kikobeats