Github Watcher

Github Watcher is an easy-to-use extendable framework for setting up custom reactions on various triggers.

Supported triggers

• Github: new PR, new Issue, failed workflow run

Supported reactions

• Telegram message

Usage

It can be easily setup in CI by github-watcher-action, example:

• workflow
• config

For any advanced use cases, it can be used as a standalone service by running the backend service in docker. Example:

docker run \
  --rm \
  --volume ./backend/example/settings.yaml:/settings.yaml \  # provide settings file
  --volume ./backend/example/config.yaml:/config.yaml \  # provide config file for yaml_file config backend
  --volume ./backend/example/state:/state \  # provide state directory for local_dir state backend
  --env GITHUB_WATCHER_SETTINGS_YAML=/settings.yaml \
  --env GITHUB_TOKEN \
  --env TELEGRAM_CHAT_ID \
  --env TELEGRAM_BOT_TOKEN \
  ghcr.io/ovsds/github-watcher:0.3.0

Backend

The backend service is responsible for handling triggers and reactions. More information can be found in backend/README.md.

Development

Global dependencies

• Taskfile
• nvm

Taskfile commands

For all commands see Taskfile or task --list-all.

License

MIT