Skip to content

A GitHub Action to send Slack/Teams notification for Pull Request that are waiting for reviewers.

License

Notifications You must be signed in to change notification settings

Soomgo-Mobile/pr-reviews-reminder-action

 
 

Repository files navigation

Pull Request reviews reminder action

Coverage Status Maintainability Donate

Action to send Slack/Teams notifications when there are pull requests pending for reviews.

Preview

Preview

Inputs

webhook-url

The webhook URL (required). More info here (Slack) and here (Teams).

provider

Chat provider, slack or msteams (required). Default slack.

channel

The channel name, eg: #general (optional).

github-provider-map

A string like this "githubusername1:provideruserid1,githubusername2:provideruserid2,..." to define the mapping between GitHub usernames and Slack user IDs (optional). Example: "DavideViolante:UEABCDEFG,foobar:UAABCDEFG". Note: it's case sensitive! How to find Slack User IDs.

Example usage

name: PRs reviews reminder

on:
  schedule:
    # Every weekday every 2 hours during working hours, send notification
    - cron: "0 8-17/2 * * 1-5"

jobs:
  pr-reviews-reminder:
    runs-on: ubuntu-latest
    steps:
    - uses: davideviolante/[email protected]
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      with:
        webhook-url: '' # Required
        provider: '' # Required (slack or msteams)
        channel: '' # Optional, eg: #general
        github-provider-map: '' # Optional, eg: "DavideViolante:UEABCDEFG,foobar:UAABCDEFG"

Bug or feedback?

Please open an issue.

Author

About

A GitHub Action to send Slack/Teams notification for Pull Request that are waiting for reviewers.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%