Giter Club home page Giter Club logo

issue-label-notification-action's Introduction

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/[email protected]
          with:
             recipients: |
                  help wanted=@jenschelkopf
                  documentation=@jenschelkopf @docs-team

issue-label-notification-action's People

Contributors

alexcnichols avatar jenschelkopf avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

issue-label-notification-action's Issues

Please update to fix github deprecation notice

Hi! We're (@adafruit) a user of this action, and we get the following notification when it runs:

Node.js 12 actions are deprecated. For more information see: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/. Please update the following actions to use Node.js 16: jenschelkopf/issue-label-notification-action

If this won't be possible, please let us know so that we can look for an alternative.

Thank you.

Team mentions in comments does not result in notifications

I've got a config ala:

jobs:
  notify:
    runs-on: ubuntu-latest
    steps:
        - uses: jenschelkopf/[email protected]
          with:
             recipients: |
                  help wanted=@org-name/team-name

When the help wanted label is applied I see the comment posted as expected, but the team mention (@org-name/team-name) does not cause notifications to be sent.

Notably this does work for individual mentions (@krukow) but not for org-namespaced/team names @org/team

I've validated that if I create a comment using curl + REST, I do get the results as expected, so I believe the difference must be in this action or in octokit/rest.js?

i.e. this correctly notifies the team:

curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" -H "Authorization: token [REDACTED]" \
  https://api.github.com/repos/[redacted]/[redacted]/issues/[N]/comments \
  -d '{"body":"Heads up @org-name/team-name - the 'help-wanted' label was applied to this issue."}'

Action does not fire if a bot labels the issue

I am working on a scenario that a GitHub action workflow will fire when issues are created.

Not working - bot labels the issue
If the issue contains specific text then an action will automatically add a label to the issue using the context of a bot. In this scenario the issue label notification never fires.

Example
BrianTJackett/issue-notification-workflow#11

Working - user labels the issue
If I change the auto labeler to use a personal access token (PAT) the label is added as my own account and not a bot. In this scenario the issue label notification does fire.

Example
BrianTJackett/issue-notification-workflow#12

Is there a reason why this action would not fire when a bot labels the issue? Thanks for providing this community action and any help you can offer.

Option to edit issue instead of posting comment

When the action posts a comment, the email notification that one gets doesn't have any context other than the title of the issue. This means I get notified, but I always have to click in to open the issue in the browser to understand what issue the label was added to.

I think if the action instead modified the issue description, appending a line like


cc @someuser @anotheruser

it would instead include the whole issue body text in the email notification, the same way that it is included when e.g. being assigned to an issue.

What do you think about having an option for this?

Notification not working

Here's my workflow. When I create / add a 'bug' label to an issue, the notification isn't sent. Any help would be awesome!!
Screen Shot 2020-09-15 at 11 52 38 AM

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.