github/github-releases-notifier
0
0
Fork 0
mirror of https://github.com/thegeeklab/github-releases-notifier.git synced 2024-11-21 12:40:38 +00:00
Code Issues Releases Activity
GitHub release notification bot
16 Commits 1 Branch 5 Tags 477 KiB
Go 100%
488b8ded8f
Go to file
Matthias Loibl 488b8ded8f
Fix typo in the README.md
2017-08-08 16:30:43 +02:00
deployments Create example deployments for kubernetes and docker-compose 2017-08-08 15:06:07 +02:00
vendor Update github.com/shurcooL/githubql dependency 2017-08-08 14:12:45 +02: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
.travis.yml Create a Dockerfile and .travis.yml 2017-08-08 14:58:15 +02:00
Dockerfile Create a Dockerfile and .travis.yml 2017-08-08 14:58:15 +02:00
LICENSE Initial commit 2017-08-08 11:46:15 +02:00
main.go Add all Go source files 2017-08-08 12:08:16 +02:00
Makefile Add a Makefile 2017-08-08 12:37:23 +02:00
README.md Fix typo in the README.md 2017-08-08 16:30:43 +02:00
release.go Add all Go source files 2017-08-08 12:08:16 +02:00
releasechecker.go Set the timeout for GitHub and Slack to 5s 2017-08-08 14:38:31 +02:00
repository.go Add all Go source files 2017-08-08 12:08:16 +02:00
screenshot.png Add a screenshot and description on how to watch repos 2017-08-08 16:28:17 +02:00
slack.go Set the timeout for GitHub and Slack to 5s 2017-08-08 14:38:31 +02:00
VERSION Add a Makefile 2017-08-08 12:37:23 +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/... justwatch/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.