https://github.com/sauravexodus/github-slack-pr-reminders
Slack PR reminders. Because we developers are lazy 😂
https://github.com/sauravexodus/github-slack-pr-reminders
engineering-management engineering-tools github-api graphql jsonpath productivity-booster slack-api slack-bot typescript
Last synced: about 2 months ago
JSON representation
Slack PR reminders. Because we developers are lazy 😂
- Host: GitHub
- URL: https://github.com/sauravexodus/github-slack-pr-reminders
- Owner: sauravexodus
- Created: 2019-01-07T08:49:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-07T18:42:15.000Z (over 7 years ago)
- Last Synced: 2025-05-17T22:35:48.566Z (about 1 year ago)
- Topics: engineering-management, engineering-tools, github-api, graphql, jsonpath, productivity-booster, slack-api, slack-bot, typescript
- Language: TypeScript
- Size: 28.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ⚠️ Pull Request Reminders on Slack
## 🗜 Requirements
1. Create a slack bot and obtain the OAuth token. (e.g `xoxb-##################...####`)
2. Github OAuth token
3. Organization name
## 🚦 Running the code
1. Create a `channelMappings.json` file inside `channelMaps` folder.
2. Run the build script: `npm run build:commonjs`
3. Run the script: `SLACK_TOKEN='' GITHUB_TOKEN='' ORG_NAME='' node lib/index.js`
Tip: You can put this code into a `run.sh` file
## 💻 How to use
1. Put this code in a pubsub and trigger it from a cron service.
2. Use this as a heroku worker with the heroku scheduler [plugin](https://elements.heroku.com/addons/scheduler). (Free but needs you add a credit card 🤷♂️)
## Creating the mappings file
Mappings file is source of mapping between the github developer username and slack channel id.
Use slack api to find out channel ids for your slack users.
1. List down user ids: https://slack.com/api/users.list
2. Get channel for each user: https://slack.com/api/conversations.open
### More details
https://api.slack.com/methods
### Sample
`channelMappings.json` should look something like:
```
{
"johnnyblaze": {
"channelId": "DX12989821"
}
}
```
## Future implementation
1. Convert this into a one click installable slack app.
2. Figure out a way to exempt developers from reminders who have already shared a review.
## 🍺 Contributing
1. Fork the project.
2. Clone it locally.
3. Open a PR 🎉 targeting the source branch