https://github.com/duncanmcclean/post-release-comments

GitHub Action which comments on Issues and Pull Requests when they've been addressed within a release.
https://github.com/duncanmcclean/post-release-comments

github-actions hacktoberfest release-automation

Last synced: 9 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/duncanmcclean/post-release-comments
• Owner: duncanmcclean
• License: mit
• Created: 2021-10-23T19:50:45.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-29T06:26:00.000Z (3 months ago)
• Last Synced: 2024-10-14T10:48:54.846Z (23 days ago)
• Topics: github-actions, hacktoberfest, release-automation
• Language: JavaScript
• Homepage:
• Size: 1.21 MB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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`](https://github.com/statamic/changelog-action) for this.

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

```yaml

- 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](https://github.com/sponsors/duncanmcclean).

## 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

```