0
0
mirror of https://github.com/thegeeklab/github-releases-notifier.git synced 2024-11-14 18:10:40 +00:00
github-releases-notifier/README.md

29 lines
1.6 KiB
Markdown
Raw Normal View History

2017-08-08 13:35:33 +00:00
# github-releases-notifier
2020-09-21 07:15:27 +00:00
GitHub release notification bot
2020-01-14 13:44:08 +00:00
2020-09-21 07:15:27 +00:00
[![Build Status](https://img.shields.io/drone/build/thegeeklab/github-releases-notifier?logo=drone)](https://cloud.drone.io/thegeeklab/github-releases-notifier)
[![Docker Hub](https://img.shields.io/badge/dockerhub-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/thegeeklab/github-releases-notifier)
[![Quay.io](https://img.shields.io/badge/quay-latest-blue.svg?logo=docker&logoColor=white)](https://quay.io/repository/thegeeklab/github-releases-notifier)
2020-09-21 07:23:25 +00:00
[![Go Report Card](https://goreportcard.com/badge/github.com/thegeeklab/github-releases-notifier)](https://goreportcard.com/report/github.com/thegeeklab/github-releases-notifier)
2020-09-21 07:15:27 +00:00
[![Source: GitHub](https://img.shields.io/badge/source-github-blue.svg?logo=github&logoColor=white)](https://github.com/thegeeklab/github-releases-notifier)
[![License: MIT](https://img.shields.io/github/license/thegeeklab/github-releases-notifier)](<[LICENSE](https://github.com/thegeeklab/github-releases-notifier/blob/master/LICENSE)>)
2017-08-08 13:35:33 +00:00
Receive Slack notifications if a new release of your favorite software is available on GitHub.
2020-09-21 07:15:27 +00:00
## Setup
2020-09-21 07:15:27 +00: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).
2020-09-21 07:15:27 +00:00
To watch repositories simply add them to the list of arguments e.g. `-r=kubernetes/kubernetes -r=prometheus/prometheus`.
2020-09-21 07:15:27 +00:00
### Docker
2017-08-08 13:35:33 +00:00
2020-09-21 07:15:27 +00: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 13:35:33 +00:00
```