0
0
mirror of https://github.com/thegeeklab/github-releases-notifier.git synced 2024-06-02 17:49:40 +02:00
github-releases-notifier/README.md

1.7 KiB

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.