2017-08-08 15:35:33 +02:00
# github-releases-notifier
2020-09-21 09:15:27 +02:00
GitHub release notification bot
2020-01-14 14:44:08 +01:00
2020-09-21 09:15:27 +02:00
[](https://cloud.drone.io/thegeeklab/github-releases-notifier)
[](https://hub.docker.com/r/thegeeklab/github-releases-notifier)
[](https://quay.io/repository/thegeeklab/github-releases-notifier)
2020-09-21 09:23:25 +02:00
[](https://goreportcard.com/report/github.com/thegeeklab/github-releases-notifier)
2020-09-21 20:56:35 +02:00
[](https://github.com/thegeeklab/github-releases-notifier/graphs/contributors)
2020-09-21 09:15:27 +02:00
[](https://github.com/thegeeklab/github-releases-notifier)
2020-09-25 18:43:39 +02:00
[](https://github.com/thegeeklab/github-releases-notifier/blob/master/LICENSE)
2017-08-08 15:35:33 +02:00
Receive Slack notifications if a new release of your favorite software is available on GitHub.
2020-09-21 09:15:27 +02:00
## Setup
2017-08-08 16:28:17 +02:00
2020-09-21 09:15:27 +02:00
1. Get a URL to send WebHooks to your Slack.
2. Get a token for scraping GitHub: [https://help.github.com/ ](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token ).
2017-08-08 16:28:17 +02:00
2020-09-21 09:15:27 +02:00
To watch repositories simply add them to the list of arguments e.g. `-r=kubernetes/kubernetes -r=prometheus/prometheus` .
2017-08-08 16:28:17 +02:00
2020-09-21 09:15:27 +02:00
### Docker
2017-08-08 15:35:33 +02:00
2020-09-21 09:15:27 +02:00
```Shell
docker run --rm \
-e GITHUB_TOKEN=XXX \
-e SLACK_HOOK=https://hooks.slack.com/... \
thegeeklab/github-releases-notifier -r=kubernetes/kubernetes
2017-08-08 15:35:33 +02:00
```
2020-09-21 20:56:35 +02:00
## Contributors
Special thanks goes to all [contributors ](https://github.com/thegeeklab/github-releases-notifier/graphs/contributors ).
## License
This project is licensed under the MIT License - see the [LICENSE ](https://github.com/thegeeklab/github-releases-notifier/blob/master/LICENSE ) file for details.
