Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/taiki-e/create-gh-release-action
GitHub Action for creating GitHub Releases based on changelog.
https://github.com/taiki-e/create-gh-release-action
github-actions
Last synced: 16 days ago
JSON representation
GitHub Action for creating GitHub Releases based on changelog.
- Host: GitHub
- URL: https://github.com/taiki-e/create-gh-release-action
- Owner: taiki-e
- License: apache-2.0
- Created: 2021-02-03T12:07:34.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-23T15:52:33.000Z (2 months ago)
- Last Synced: 2024-05-01T23:58:15.871Z (about 2 months ago)
- Topics: github-actions
- Language: Shell
- Homepage:
- Size: 139 KB
- Stars: 65
- Watchers: 3
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Lists
- my-awesome-stars - taiki-e/create-gh-release-action - GitHub Action for creating GitHub Releases based on changelog. (Shell)
- my-awesome-stars - taiki-e/create-gh-release-action - GitHub Action for creating GitHub Releases based on changelog. (Shell)
README
# create-gh-release-action
[](https://github.com/taiki-e/create-gh-release-action/releases/latest)
[](https://github.com/taiki-e/create-gh-release-action/actions)
GitHub Action for creating GitHub Releases based on changelog.
- [Usage](#usage)
- [Inputs](#inputs)
- [Outputs](#outputs)
- [Example workflow: Basic usage](#example-workflow-basic-usage)
- [Example workflow: Create a draft release](#example-workflow-create-a-draft-release)
- [Example workflow: Custom title](#example-workflow-custom-title)
- [Example workflow: No changelog](#example-workflow-no-changelog)
- [Example workflow: Reject releases from outside of main branch](#example-workflow-reject-releases-from-outside-of-main-branch)
- [Other examples](#other-examples)
- [Supported events](#supported-events)
- [Compatibility](#compatibility)
- [Related Projects](#related-projects)
- [License](#license)
## Usage
This action creates GitHub Releases based on changelog that specified by `changelog` option.
Currently, changelog format and supported tag names have the following rule:
- This action uses [parse-changelog] to parse changelog.
Only the changelog format accepted by [parse-changelog] is supported.
Basically, [Keep a Changelog][keepachangelog] and similar formats are
supported, but we recommend checking if [parse-changelog] can parse your
project's changelog as you expected.
[If the `changelog` option is not specified, the changelog is ignored and only the release created.](#example-workflow-no-changelog)
- The supported tag format is `v?MAJOR.MINOR.PATCH(-PRERELEASE)?(+BUILD_METADATA)?`.
(leading "v", pre-release version, and build metadata are optional.) The optional prefix is also supported.
This is based on [Semantic Versioning][semver]
### Inputs
| Name | Required | Description | Type | Default |
|-----------|:------------:|-----------------------------------------------------------------------------|---------|---------|
| token | **true** [^1]| GitHub token for creating GitHub Releases (see [action.yml](action.yml) for more) | String | |
| changelog | false | Path to changelog (variables `$tag`, `$version`, `$prefix`, and any string) | String | |
| allow-missing-changelog | false | Create the release even if the changelog entry corresponding to the version is missing. The default value of the changelog will be an empty string. | Boolean | `false` |
| title | false | Format of title (variables `$tag`, `$version`, `$prefix`, and any string) | String | `$tag` |
| draft | false | Create a draft release (`true` or `false`) | Boolean | `false` |
| branch | false | Reject releases from commits not contained in branches that match the specified pattern (regular expression) | String | |
| prefix | false | An optional pattern that matches a prefix for the release tag, before the version number (see [action.yml](action.yml) for more) | String | |
| ref | false | Fully-formed tag ref for this release (see [action.yml](action.yml) for more) | String | |
[^1]: Required one of `token` input option or `GITHUB_TOKEN` environment variable.
### Outputs
| Name | Description |
|-----------------|----------------------------------------------------------------------------------------------------------------|
| computed-prefix | The computed prefix, including '-' and 'v'. |
| version | The version number extracted from the tag. The tag name is a concatenation of `computed-prefix` and `version`. |
### Example workflow: Basic usage
```yaml
name: Release
permissions:
contents: write
on:
push:
tags:
- v[0-9]+.*
jobs:
create-release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: taiki-e/create-gh-release-action@v1
with:
# (Optional) Path to changelog.
changelog: CHANGELOG.md
# (Required) GitHub token for creating GitHub Releases.
token: ${{ secrets.GITHUB_TOKEN }}
```
### Example workflow: Create a draft release
```yaml
name: Release
permissions:
contents: write
on:
push:
tags:
- v[0-9]+.*
jobs:
create-release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: taiki-e/create-gh-release-action@v1
with:
# (Optional) Path to changelog.
changelog: CHANGELOG.md
# (Optional) Create a draft release.
# [default value: false]
draft: true
# (Required) GitHub token for creating GitHub Releases.
token: ${{ secrets.GITHUB_TOKEN }}
```
### Example workflow: Custom title
You can customize the title of the release by `title` option.
*[Example of the created release.](https://github.com/taiki-e/pin-project/releases/tag/v1.0.4)*
```yaml
name: Release
permissions:
contents: write
on:
push:
tags:
- v[0-9]+.*
jobs:
create-release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: taiki-e/create-gh-release-action@v1
with:
# (Optional)
changelog: CHANGELOG.md
# (Optional) Format of title.
# [default value: $tag]
# [possible values: variables $tag, $version, and any string]
title: $version
# (Required) GitHub token for creating GitHub Releases.
token: ${{ secrets.GITHUB_TOKEN }}
```
### Example workflow: No changelog
If the `changelog` option is not specified, the changelog is ignored and only the release created.
*[Example of the created release.](https://github.com/openrr/urdf-viz/releases/tag/v0.23.1)*
```yaml
name: Release
permissions:
contents: write
on:
push:
tags:
- v[0-9]+.*
jobs:
create-release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: taiki-e/create-gh-release-action@v1
with:
# (Required) GitHub token for creating GitHub Releases.
token: ${{ secrets.GITHUB_TOKEN }}
```
### Example workflow: Reject releases from outside of main branch
You can reject releases from commits not contained in branches that match the specified pattern by using `branch` option.
```yaml
name: Release
permissions:
contents: write
on:
push:
tags:
- v[0-9]+.*
jobs:
create-release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: taiki-e/create-gh-release-action@v1
with:
# (Optional) Path to changelog.
changelog: CHANGELOG.md
# (Optional) Reject releases from commits not contained in branches
# that match the specified pattern (regular expression)
branch: main
# (Required) GitHub token for creating GitHub Releases.
token: ${{ secrets.GITHUB_TOKEN }}
```
### Other examples
- [cargo-hack](https://github.com/taiki-e/cargo-hack/blob/202e6e59d491c9202ce148c9ef423853267226db/.github/workflows/release.yml#L25-L45)
- [tracing](https://github.com/tokio-rs/tracing/blob/2aa0cb010d8a7fa0de610413b5acd4557a00dd34/.github/workflows/release.yml#L10-L24)
## Supported events
The following two events are supported by default:
- tags ([`on.push.tags`](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#push))
For example:
```yaml
on:
push:
tags:
- v[0-9]+.*
```
- GitHub release ([`on.release`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#release))
For example:
```yaml
on:
release:
types: [created]
```
You can create a release from arbitrary event to arbitrary tag by specifying the `ref` input option.
For example, to create a release to the `my_tag` tag, specify `ref` input option as follows:
```yaml
with:
ref: refs/tags/my_tag
```
## Compatibility
This action has been tested for GitHub-hosted runners (Ubuntu, macOS, Windows).
To use this action in self-hosted runners or in containers, at least the following tools are required:
- bash, GNU Coreutils, GNU grep, GNU tar
- curl
- git
- [gh (GitHub CLI)](https://github.com/cli/cli#installation)
## Related Projects
- [upload-rust-binary-action]: GitHub Action for building and uploading Rust binary to GitHub Releases.
- [parse-changelog]: Simple changelog parser, written in Rust. Used in this action.
- [setup-cross-toolchain-action]: GitHub Action for setup toolchains for cross compilation and cross testing for Rust.
- [install-action]: GitHub Action for installing development tools (mainly from GitHub Releases).
- [cache-cargo-install-action]: GitHub Action for `cargo install` with cache.
[cache-cargo-install-action]: https://github.com/taiki-e/cache-cargo-install-action
[install-action]: https://github.com/taiki-e/install-action
[keepachangelog]: https://keepachangelog.com/en/1.0.0
[parse-changelog]: https://github.com/taiki-e/parse-changelog
[semver]: https://semver.org
[setup-cross-toolchain-action]: https://github.com/taiki-e/setup-cross-toolchain-action
[upload-rust-binary-action]: https://github.com/taiki-e/upload-rust-binary-action
## License
Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or
[MIT license](LICENSE-MIT) at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.