This action automatically creates a release issue which includes pull requests after the latest release. It's inspired by git-pr-release.
Required Prefix of release tag written in regex. git-issue-release uses it to find the latest release. Default "^v" (starts with v).
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.
Issue title for release issue.
Issue title after published. :tag_name: is replaced by a released tag name.
An additional description for the release issue. It is inserted to the top of a body of an issue.
The file path in the repository for an additional description for release issue. The file content is inserted to the top of a body of an issue. If this parameter exists, description parameter will be ignored.
Specifies a path to a file in the repository containing configuration settings used for generating the release notes. More details.
Full example: https://github.com/kouki-dan/git-issue-release/blob/main/.github/workflows/git-issue-release.yml
name: git-issue-release
on:
push: # Automatically create or update issues when pull request is merged.
branches:
- main # Replace this with your main branch
release: # Automatically close the latest issue when release is published.
types: [released]
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.