mirror of
https://github.com/thegeeklab/github-releases-notifier.git
synced 2024-11-21 22:40:39 +00:00
38 lines
2.1 KiB
Markdown
38 lines
2.1 KiB
Markdown
# github-releases-notifier
|
|
|
|
GitHub release notification bot
|
|
|
|
[](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)
|
|
[](https://goreportcard.com/report/github.com/thegeeklab/github-releases-notifier)
|
|
[](https://github.com/thegeeklab/github-releases-notifier/graphs/contributors)
|
|
[](https://github.com/thegeeklab/github-releases-notifier)
|
|
[](https://github.com/thegeeklab/github-releases-notifier/blob/master/LICENSE)
|
|
|
|
Receive Slack notifications if a new release of your favorite software is available on GitHub.
|
|
|
|
## Setup
|
|
|
|
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).
|
|
|
|
To watch repositories simply add them to the list of arguments e.g. `-r=kubernetes/kubernetes -r=prometheus/prometheus`.
|
|
|
|
### Docker
|
|
|
|
```Shell
|
|
docker run --rm \
|
|
-e GITHUB_TOKEN=XXX \
|
|
-e SLACK_HOOK=https://hooks.slack.com/... \
|
|
thegeeklab/github-releases-notifier -r=kubernetes/kubernetes
|
|
```
|
|
|
|
## 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.
|