Code Monkey home page Code Monkey logo

github-watcher's Introduction

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:

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

  • node

Taskfile commands

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

License

MIT

github-watcher's People

Contributors

ovsds avatar

github-watcher's Issues

Add query_state options

class JobProcessorQueueStateMode(str, enum.Enum):
    PRESERVE = "preserve"
    PRESERVE_ALL = "preserve_all"
    RESTART = "restart"
    RESTART_ALL = "restart_all"
    IGNORE = "ignore"
    CLEAN = "clean"

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.