Skip to content
hash

GitHub Action

Post Release Comments

v1.0.6 Latest version

Post Release Comments

hash

Post Release Comments

Automates the process of commenting on Issues/PRs when related fixes have been released

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Post Release Comments

uses: duncanmcclean/[email protected]

Learn more about this action in duncanmcclean/post-release-comments

Choose a version

Post Release Comments

A GitHub Action which comments on Issues and Pull Requests when they've been addressed within a release.

Example

  1. User opens GitHub Issue #123 with a bug
  2. Maintainer fixes #123 & closes issue
  3. Maintainer tags a new release containing the fix
  4. This action will leave a comment on Issue #123: Released as part of v1.2.3

Usage

This action assumes you keep a CHANGELOG.md and you have some way of getting the latest release from that changelog. I often use statamic/changelog-action for this.

Anyways, this is how you'd implement this in an Actions workflow:

- name: Comment on related issues
  uses: duncanmcclean/[email protected]
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  with:
    version: ${{ github.ref }}
    changelog: ${{ steps.changelog.outputs.text }}

Sponsor me!

If you use this Action in one of your workflows, I'd appreciate it if you'd consider sponsoring me.

Notes to self

Steps to release

npm run prepare
git add dist
git commit -m "v1.x.x"
git push
git tag v1.x.x
git push --tags