github-generate-release

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

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

1.0.9 (2024-09-23)

Bug Fixes

• best effort (305ca7b)

1.0.8 (2024-07-18)

Bug Fixes

• more error details (fecec06)

1.0.7 (2024-07-18)

1.0.6 (2024-05-08)

1.0.5 (2024-02-09)

1.0.4 (2024-01-08)

Bug Fixes

• handle redirect manually (91ee570)

1.0.3 (2024-01-04)

Bug Fixes

• support https git urls (#2) (4b81c1b)

1.0.2 (2024-01-04)

1.0.1 (2024-01-04)

1.0.0 (2024-01-02)

0.0.2 (2024-01-02)

0.0.1 (2024-01-02)