https://github.com/kikobeats/github-generate-release

Simplest way to create a GitHub release.
https://github.com/kikobeats/github-generate-release

github github-actions github-actions-ci github-api github-release github-releases

Last synced: 2 days ago
JSON representation

Simplest way to create a GitHub release.

• Host: GitHub
• URL: https://github.com/kikobeats/github-generate-release
• Owner: Kikobeats
• License: mit
• Created: 2024-01-02T16:21:32.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2024-09-23T14:16:09.000Z (3 months ago)
• Last Synced: 2024-10-17T17:56:35.778Z (2 months ago)
• Topics: github, github-actions, github-actions-ci, github-api, github-release, github-releases
• Language: JavaScript
• Homepage:
• Size: 112 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# github-generate-release

![Last version](https://img.shields.io/github/tag/kikobeats/github-generate-release.svg?style=flat-square)

[![NPM Status](https://img.shields.io/npm/dm/github-generate-release.svg?style=flat-square)](https://www.npmjs.org/package/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](https://github.com/Kikobeats/github-generate-release/blob/5a9db649b79ed0bb01194413e1dcc4818e82d155/.github/workflows/main.yml#L63)).

## Getting Started

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

```sh

npx github-generate-release

```

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

```json

{

  "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](https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#create-a-release):

```sh

npx github-generate-release --draft

```

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

```js

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

await release({ draft: true })

```

## License

**github-generate-release** © [Kiko Beats](https://kikobeats.com), released under the [MIT](https://github.com/kikobeats/github-generate-release/blob/master/LICENSE.md) License.


Authored and maintained by [Kiko Beats](https://kikobeats.com) with help from [contributors](https://github.com/kikobeats/github-generate-release/contributors).

> [kikobeats.com](https://kikobeats.com) · GitHub [Kiko Beats](https://github.com/kikobeats) · Twitter [@kikobeats](https://twitter.com/kikobeats)