You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
Release Commenter
v1.0.1-dev.1
Pre-release
This GitHub Action automatically comments on PRs and Issues when a fix is released for them.
Use this action in a workflow triggered by a release. It will scan commits between that and the prior release, find associated Issues and PRs, and comment on them to let people know a release has been made. Associated Issues and PRs can be directly linked to the commit or manually linked from a PR associated with the commit.
on:
release:
types: [published]
jobs:
release:
steps:
- uses: apexskier/github-release-commenter@latest
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
These are some known limitations of this action. I'd like to try to address them in the future.
- Non-linear releases aren't supported. For example, releasing a patch to a prior major release after a new major release has been bumped.
- Non-sequential releases aren't supported. For example, if you release multiple prereleases between two official releases, this will only create a comment for the first prerelease in which a fix is released, not the final release.
- The first release for a project will be ignored. This is intentional, as the use case is unlikely. Most projects will either have several alphas that don't need release comments, or won't use issues/PRs for the first commit.