Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davideviolante/pr-reviews-reminder-action
A GitHub Action to send Slack/Teams notification for Pull Request that are waiting for reviewers.
https://github.com/davideviolante/pr-reviews-reminder-action
github-action github-actions microsoft-teams notification pr pull-requests reviews slack teams webhook
Last synced: about 13 hours ago
JSON representation
A GitHub Action to send Slack/Teams notification for Pull Request that are waiting for reviewers.
- Host: GitHub
- URL: https://github.com/davideviolante/pr-reviews-reminder-action
- Owner: DavideViolante
- License: mit
- Created: 2020-05-11T08:04:57.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-01-01T14:16:21.000Z (21 days ago)
- Last Synced: 2025-01-15T04:36:33.168Z (8 days ago)
- Topics: github-action, github-actions, microsoft-teams, notification, pr, pull-requests, reviews, slack, teams, webhook
- Language: JavaScript
- Homepage:
- Size: 1.17 MB
- Stars: 45
- Watchers: 4
- Forks: 20
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pull Request reviews reminder action
[](https://github.com/DavideViolante/pr-reviews-reminder-action/actions?query=workflow%3A%22Node.js+CI%22) [](https://coveralls.io/github/DavideViolante/pr-reviews-reminder-action?branch=master) [](https://codeclimate.com/github/DavideViolante/pr-reviews-reminder-action/maintainability) [](https://www.paypal.me/dviolante)
Action to send Slack/Rocket/Teams notifications when there are pull requests pending for reviews.
## Preview
## Inputs
### webhook-url
The webhook URL (required). More info [here (Slack)](https://api.slack.com/messaging/webhooks) and [here (Teams)](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/connectors-using#setting-up-a-custom-incoming-webhook).
### provider
Chat provider, `slack`, `rocket` 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/MS Teams user IDs (optional). Example: `"DavideViolante:UEABCDEFG,foobar:UAABCDEFG"`. Note: it's case sensitive! [How to find Slack User IDs](https://www.google.com/search?q=find+slack+user+id).
For MS Teams, the provider user ID can be an [MS teams user ID or a UPN](https://www.google.com/search?q=find+%22microsoft+teams%22+userprincipalname+-office) Example: `"DavideViolante:[email protected]',foobar:[email protected]"`.
Another hacky way (no code) to find the MS Teams UPN is the following: open MS Teams on your browser, click the 3 dots near your Team name, click Add member, open Google Chrome console Network tab Fetch/XHR category, type the email address, look for "searchV2" in the Network tab, click Response tab.
### ignore-label
Ignore Pull Requests with that label(s), eg: `no-reminder` or `no-reminder,ignore me` (optional).
## Example usage
```yaml
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, rocket or msteams)
channel: '' # Optional, eg: #general
github-provider-map: '' # Optional, eg: DavideViolante:UEABCDEFG,foobar:UAABCDEFG
ignore-label: '' # Optional, eg: no-reminder,ignore me
```
## Bug or feedback?
Please open an issue.
## Author
- [Davide Violante](https://github.com/DavideViolante)