Skip to content

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

License

Notifications You must be signed in to change notification settings

duncanmcclean/post-release-comments

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

Repository files navigation

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

About

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

Topics

Resources

License

Stars

Watchers

Forks