Skip to content

GitHub Action for creating GitHub Releases based on changelog.

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

taiki-e/create-gh-release-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

create-gh-release-action

build status

GitHub Action for creating GitHub Releases based on changelog.

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:

Inputs

Name Required Description Type Default
token true 1 GitHub token for creating GitHub Releases (see action.yml for more) String
changelog false Path to changelog (variables $tag, $version, $prefix, and any string) String
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 for more) String
ref false Fully-formed tag ref for this release (see action.yml for more) String

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

name: Release

permissions:
  contents: write

on:
  push:
    tags:
      - v[0-9]+.*

jobs:
  create-release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - 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

name: Release

permissions:
  contents: write

on:
  push:
    tags:
      - v[0-9]+.*

jobs:
  create-release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - 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.

name: Release

permissions:
  contents: write

on:
  push:
    tags:
      - v[0-9]+.*

jobs:
  create-release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - 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.

name: Release

permissions:
  contents: write

on:
  push:
    tags:
      - v[0-9]+.*

jobs:
  create-release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - 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.

name: Release

permissions:
  contents: write

on:
  push:
    tags:
      - v[0-9]+.*

jobs:
  create-release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - 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

Compatibility

This action has been tested for action runners hosted by GitHub. To use this action in self-hosted runners or in containers, you will need to install at least the following:

  • bash, GNU Coreutils, GNU grep, GNU tar
  • curl
  • git
  • gh (GitHub CLI)

Related Projects

License

Licensed under either of Apache License, Version 2.0 or MIT license 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.

Footnotes

  1. Required one of token input option or GITHUB_TOKEN environment variable.

About

GitHub Action for creating GitHub Releases based on changelog.

Topics

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Code of conduct

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Languages