https://github.com/cucumber/action-create-github-release
Create a GitHub Release containing the release notes from the CHANGELOG
https://github.com/cucumber/action-create-github-release
polyglot-release
Last synced: 5 months ago
JSON representation
Create a GitHub Release containing the release notes from the CHANGELOG
- Host: GitHub
- URL: https://github.com/cucumber/action-create-github-release
- Owner: cucumber
- License: mit
- Created: 2021-08-21T00:51:26.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-09-07T14:01:39.000Z (almost 3 years ago)
- Last Synced: 2024-04-15T13:29:15.514Z (about 2 years ago)
- Topics: polyglot-release
- Language: Shell
- Homepage:
- Size: 121 KB
- Stars: 0
- Watchers: 4
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# create-github-release
This action was developed by the Cucumber team to use as part of our automated release process.
It is designed to run on push to a `release/*` branch, to create a GitHub Release containing the release notes from the CHANGELOG, and tag the commit being released.
It uses the `changelog` tool to read the version number and notes for the latest release, then calls the GitHub API to create a Release on the GitHub repo.
It creates a git tag of the form `vX.Y.Z` and looks in the root directory for the `CHANGELOG.md` file.
## Inputs
The action requires a token to call the GitHub API to create the Release:
* `github-token`
The token needs 'write' permissions on the repo.
## Example
````yaml
name: Release
on:
push:
branches: [release/*]
jobs:
create-release:
runs-on: ubuntu-latest
environment: Release
permissions:
contents: write
steps:
- uses: actions/checkout@v2
- uses: cucumber/actions-create-github-release@v1.1.0
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
````