https://github.com/kbrashears5/github-action-release-maker
Github Action to create a release when triggered
https://github.com/kbrashears5/github-action-release-maker
creator maker release utilities
Last synced: about 1 year ago
JSON representation
Github Action to create a release when triggered
- Host: GitHub
- URL: https://github.com/kbrashears5/github-action-release-maker
- Owner: kbrashears5
- License: mit
- Created: 2020-09-07T21:37:30.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2023-09-11T05:10:30.000Z (almost 3 years ago)
- Last Synced: 2025-02-19T18:39:58.756Z (over 1 year ago)
- Topics: creator, maker, release, utilities
- Language: Shell
- Homepage: https://github.com/kbrashears5/github-action-release-maker
- Size: 25.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github-action-release-maker
Github Action to create a release when triggered
[](https://img.shields.io/github/v/release/kbrashears5/github-action-release-maker)
# Use Cases
Have releases be created automatically as part of your CI/CD, using your last commit message
# Setup
Create a new file called `/.github/workflows/release-maker.yml` that looks like so:
```yaml
name: Release Maker
on:
repository_dispatch:
types:
- release
jobs:
release_maker:
runs-on: ubuntu-latest
steps:
- name: Release Maker
uses: kbrashears5/github-action-release-maker@v1.0.3
with:
VERSION: ${{ github.event.client_payload.version }}
TOKEN: ${{ secrets.ACTIONS }}
```
## Parameters
| Parameter | Required | Description |
| --- | --- | --- |
| VERSION | true | Version name to give the release |
| TOKEN | true | Personal Access Token with Repo scope |
## Invoking
### cURL
```bash
curl \
-X POST \
-H "Accept: application/vnd.github.v3+json" \
-d '{"event_type":"release","client_payload":{"version":"v1.0.0"}}' \
https://api.github.com/repos/{username}/{repo-name}/dispatches
```
### Azure DevOps Pipeline
See my yaml [templates](https://github.com/kbrashears5/yaml/blob/main/templates/create-github-release.yml) on how to use.
This template will use the build number as the version of the package.
You'll need to create a variable group called `github`, with a secret variable called `GITHUB_TOKEN`, with a token with repo:public_repo scope. See my yaml [example](https://github.com/kbrashears5/yaml/blob/main/examples/azure-pipelines-node.yml) on how to use.