/pr-reviews-reminder-action

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

Primary LanguageJavaScriptMIT LicenseMIT

Pull Request reviews reminder action

Maintainability Donate

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

Inputs

webhook-url

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

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/pr-reviews-reminder-action@v1.2.0
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      with:
        webhook-url: '' # Required
        channel: '' # Optional, eg: #general
        github-provider-map: '' # Optional, eg: "DavideViolante:UEABCDEFG,foobar:UAABCDEFG"

Bug or feedback?

Please open an issue.

Author