Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Github Watcher

CI

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:

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

  • mise, activated in the shell (eval "$(mise activate zsh)")

All other tools are pinned in mise.toml.

mise tasks

For all commands see mise.toml or mise tasks ls.

License

MIT

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages