git-issue-release

This action automatically creates a release issue which includes pull requests after the latest release. It's inspired by git-pr-release.

Inputs

`release-tag-pattern`

Required Prefix of release tag written in regex. git-issue-release uses it to find the latest release. Default "^v" (starts with v).

`release-label`

Required Label of release issue. git-issue-release uses it to determine an issue as a release issue. An issue created by git-issue-release has these labels. Default "release".

If you want to add multiple labels, you can use a comma-separated string like release,appname

CAUTION: Labels are not automatically created. Please create labels before using them.

`release-issue-title`

Issue title for release issue.

`release-issue-title-published`

Issue title after published. :tag_name: is replaced by a released tag name.

`description`

An additional description for the release issue. It is inserted to the top of a body of an issue.

`configuration-file-path`

Specifies a path to a file in the repository containing configuration settings used for generating the release notes. More details.

Example usage

Full example: https://github.com/kouki-dan/git-issue-release/blob/main/.github/workflows/git-issue-release.yml

name: git-issue-release

on:
  pull_request: # Automatically create or update issues when pull request is merged.
    types: [closed]
  release: # Automatically close the latest issue when release is published.
    types: [published]

jobs:
  action:
    runs-on: ubuntu-latest
    steps:
      - name: git-issue-release
        uses: kouki-dan/git-issue-release@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          release-tag-pattern: ^v # Use it to find the latest release. `^v` means starts with v.
          release-label: "release" # Use it to find release issues. Labels are not created automatically, so create them before use it.

mazamachi / git-issue-release