https://github.com/agrc/release-issue-notifications-action

Automatically comment on closed or fixed issues after a release is published
https://github.com/agrc/release-issue-notifications-action

github-action government-app terraform-managed

Last synced: 7 months ago
JSON representation

Automatically comment on closed or fixed issues after a release is published

• Host: GitHub
• URL: https://github.com/agrc/release-issue-notifications-action
• Owner: agrc
• License: mit
• Created: 2024-06-26T19:10:41.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-15T20:50:27.000Z (9 months ago)
• Last Synced: 2025-01-15T22:54:43.772Z (9 months ago)
• Topics: github-action, government-app, terraform-managed
• Language: TypeScript
• Homepage:
• Size: 2.03 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Release Issue Notifications

[![Push Events](https://github.com/agrc/release-issue-notifications-action/actions/workflows/push.yml/badge.svg)](https://github.com/agrc/release-issue-notifications-action/actions/workflows/push.yml)

[![Release Events](https://github.com/agrc/release-issue-notifications-action/actions/workflows/release.yml/badge.svg)](https://github.com/agrc/release-issue-notifications-action/actions/workflows/release.yml)

This action posts a comment on related closed or fixed issues after a release is published with a link to the release. For example:

```markdown

🥳 This issue is included in [v1.0.0](https://github.com/agrc/release-issue-notifications-action/releases/tag/v1.0.0)

```

## Usage

`release.yml`

```yaml

name: Release Events

on:

  release:

    types: [published]

permissions:

  contents: read

  pull-requests: write

  issues: write

jobs:

  notify:

    name: Notifications

    runs-on: ubuntu-latest

    steps:

      - name: Release Notifier

        uses: agrc/release-issue-notifications-action@v1

        with:

          repo-token: ${{ secrets.GITHUB_TOKEN }}

```

## Package for Distribution

This action is built and distributed via the included GitHub action workflows.

## Local Testing

You may test some of the utilities that this action uses locally by running scripts in the `scripts` directory. For example:

```bash

npx tsx scripts/testGetIssueNumbers.ts $(gh auth token) 2a90bc980886321aca554eddc47b98c7638617b3 89327edb99c324c82aced47238c6b29e03f0a23d agrc release-issue-notifications-action

```