Skip to content
bell

GitHub Action

Issue Label Notifier

1.3 Latest version

Issue Label Notifier

bell

Issue Label Notifier

Notify individuals or teams based on issue labels

Installation

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

              

- name: Issue Label Notifier

uses: jenschelkopf/issue-label-notification-action@1.3

Learn more about this action in jenschelkopf/issue-label-notification-action

Choose a version

GitHub Action - Issue Label Notifications

This GitHub Action allows you to notify users or teams when specific labels are added to an issue. It runs every time a label is attached to an issue, and compares the label to the list of notification recipients that you specify. If a match is found, the action will add a comment to the issue and @mention the notification recipients.

Screen Shot 2020-03-27 at 3 30 46 PM

Usage

Pre-requisites

Create a workflow .yml file in your repositories .github/workflows directory. An example workflow is available below. For more information, reference the GitHub Help Documentation for Creating a workflow file.

Inputs

  • recipients: A map of labels and which individuals or teams to notify. Multiple labels can be configured by putting each on a newline. Multiple teams and/or individuals can be configured for each label by putting a space between them.
  • message: (Optional) The message to include in the comment. Must include at least {receipients} but can also include {label}. See the default message in the action.yml file.

Example workflow

name: Notify users based on issue labels

on:
  issues:
      types: [labeled]

jobs:
  notify:
    runs-on: ubuntu-latest
    steps:
        - uses: jenschelkopf/issue-label-notification-action@1.3
          with:
             recipients: |
                  help wanted=@jenschelkopf
                  documentation=@jenschelkopf @docs-team