Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/enixcoda/github-code-review-notifier
📣 Push code review notifications to Slack
https://github.com/enixcoda/github-code-review-notifier
codereview serverless slack slack-bot slackbot
Last synced: about 5 hours ago
JSON representation
📣 Push code review notifications to Slack
- Host: GitHub
- URL: https://github.com/enixcoda/github-code-review-notifier
- Owner: EnixCoda
- License: gpl-3.0
- Created: 2018-06-02T11:39:38.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T21:13:58.000Z (over 1 year ago)
- Last Synced: 2024-04-14T06:29:22.427Z (7 months ago)
- Topics: codereview, serverless, slack, slack-bot, slackbot
- Language: TypeScript
- Homepage: https://github-code-review-notifier.vercel.app
- Size: 555 KB
- Stars: 51
- Watchers: 4
- Forks: 7
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Reviewer Notifier on Slack
**⚠️ If you are here because this app stopped working, please replace the `now.sh` with `vercel.app` in your webhook URL.**
```diff
-https://github-code-review-notifier.now.sh/github?workspace=XXX
+https://github-code-review-notifier.vercel.app/github?workspace=XXX
```
---When requested to review pull request on GitHub or when your pull request has been approved, you will be notified on Slack immediately! And a direct link to the Pull Request will be provided in the message. For example,
![A picture is worths a thousand words](https://user-images.githubusercontent.com/7480839/56017581-4fcb9200-5d32-11e9-93dc-bd9f3b25a4d0.png)
## Setup
### Connect Slack workspace
1. To add `@GitHub Code Review Notifier` to your workspace, click the button below to Authorize.
2. Then you could find `@GitHub Code Review Notifier` in your workspace.
3. DM anything (e.g. `hi`) to it to get **menu**.
### Connect GitHub account
Click `Link` in the menu to link your GitHub account to the Slack workspace. Only linked users will get notifications. So don't forget to tell your teammates about this tool.
### Connect GitHub projects
You can click `Setup GitHub projects` in the menu to get a webhook for connecting your GitHub projects.
- [How to use GitHub webhook?](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/creating-webhooks)
- The events sent to it should at least include `Pull requests` and `Pull request reviews`. Or `Send me everything` for easier setup.
- The URL is bound to the workspace. And multiple projects can share one URL in one Slack workspace.## TODO
- Notify users mentioned in new comment messages
- Notify all users in a review thread when it got reply
- Notify author about all rest messages## Help
Need help? [Draft an issue](https://github.com/EnixCoda/github-code-review-notifier/issues).