GitHub release notification bot
Go to file
Robert Kaussow 57418eaed5 cleanup drone config 2020-01-15 13:56:36 +01:00
deployments Create example deployments for kubernetes and docker-compose 2017-08-08 15:06:07 +02:00
docker fix drone pipeline 2020-01-14 16:03:23 +01:00
.drone.star cleanup drone config 2020-01-15 13:56:36 +01:00
.drone.yml cleanup drone config 2020-01-15 13:56:36 +01:00
.env.example Add an .env.example 2017-08-08 12:39:05 +02:00
.gitignore Ignore .env 2017-08-08 14:32:21 +02:00
CHANGELOG.md update changelog 2020-01-15 13:56:27 +01:00
LICENSE switch to gomod and add option to ignore pre-releases 2020-01-14 13:59:59 +01:00
Makefile Add a Makefile 2017-08-08 12:37:23 +02:00
README.md fix links in readme 2020-01-14 14:44:08 +01:00
go.mod switch to gomod and add option to ignore pre-releases 2020-01-14 13:59:59 +01:00
go.sum switch to gomod and add option to ignore pre-releases 2020-01-14 13:59:59 +01:00
main.go try to cross-compile binaries 2020-01-15 12:51:34 +01:00
release.go switch to gomod and add option to ignore pre-releases 2020-01-14 13:59:59 +01:00
releasechecker.go switch to gomod and add option to ignore pre-releases 2020-01-14 13:59:59 +01:00
repository.go Add all Go source files 2017-08-08 12:08:16 +02:00
slack.go Set the timeout for GitHub and Slack to 5s 2017-08-08 14:38:31 +02:00

README.md

github-releases-notifier

Build Status Go Report Card Docker Pulls

Receive Slack notifications if a new release of your favorite software is available on GitHub.

screenshot.png

Watching repositories

To watch repositories simply add them to the list of arguments -r=kubernetes/kubernetes -r=prometheus/prometheus and so on.

Deploying

  1. Get a URL to send WebHooks to your Slack from https://api.slack.com/incoming-webhooks.
  2. Get a token for scraping GitHub: https://help.github.com/.

Docker

docker run --rm -e GITHUB_TOKEN=XXX -e SLACK_HOOK=https://hooks.slack.com/... xoxys/github-releases-notifier -r=kubernetes/kubernetes

docker-compose

  1. Change into the deployments/ folder.
  2. Open docker-compose.yml
  3. Change the token in the environment section to the ones obtained above.
  4. docker-compose up

Kubernetes

kubectl create secret generic github-releases-notifier \
        --from-literal=github=XXX` \
        --from-literal=slack=XXX

After creating the secret with your credentials you can apply the deployment:

kubectl apply -f deployments/kubernetes.yml

That's it.