Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
mail

GitHub Action

GitHub Issue Notifier

v1.0.2

GitHub Issue Notifier

mail

GitHub Issue Notifier

Notifies email receiptients of a new GitHub issue based on labels

Installation

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

              

- name: GitHub Issue Notifier

uses: timheuer/issue-notifier@v1.0.2

Learn more about this action in timheuer/issue-notifier

Choose a version

GitHub Issue Notifier

GitHubMarketplace

While yes you can subscribe to a GitHub Issue for notifications, this is only after the Issue has been created. And sometimes you don't want all the details. This was designed to monitor a specific label when it is applied to an issue (like a breaking change notification) and notify a set of recipients with the details of the issue.

Requirements

The following variables are required to be set:

  • API Key for SendGrid (Get free API key). Set this in environment variable as SENDGRID_API_KEY. I recommend putting this in your repos Settings > Secrets and using like below.

Usage

You can now consume the action by referencing the v1 branch

uses: timheuer/issue-notifier@v1
env:
  SENDGRID_API_KEY: ${{ secrets.SENDGRID_API_KEY }}
with:
  fromMailAddress: 'no-reply@example.com'
  toMailAddress: 'example@example.com'
  subject: 'A new issue was labeled'
  labelsToMonitor: 'breaking-change,major-bug'