Skip to content
tag

GitHub Action

Release Announcement Action

v0.4.1 Pre-release

Release Announcement Action

tag

Release Announcement Action

automatically comment on released pull requests and linked issues

Installation

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

              
- name: Release Announcement Action

              
  uses: remix-run/release-comment-action@v0.4.1
Learn more about this action in remix-run/release-comment-action

Choose a version

release-comment-action

A GitHub Action to automatically comment on Pull Requests and related issues about a release. Used by Remix and React Router.

Usage

Basic usage can be enabled simply by using the following.

- name: 📝 Comment on related issues and pull requests
  uses: remix-run/release-comment-action@0.4.1

This covers a lot of use cases, even this repo uses this set up, however in a monorepo set up you may want to to follow a specific package (like remix, or react-router). In those situations the following can be used to filter on only the remix tag and only commits that affect the ./packages directory.

- name: 📝 Comment on related issues and pull requests
  uses: remix-run/release-comment-action@0.4.1
  with:
    DIRECTORY_TO_CHECK: "./packages"
    PACKAGE_VERSION_TO_FOLLOW: "remix"

Options

Option Required Default
GH_TOKEN n ${{ github.token }}
GITHUB_REPOSITORY n ${{ github.repository }}
DIRECTORY_TO_CHECK n ./
PACKAGE_VERSION_TO_FOLLOW n