github-watcher-action's Introduction

GitHub Watcher Action

GitHub Watcher Action is a GitHub action for setting up custom reactions on various triggers using GitHub Watcher.

Cache is used for storing the state.

Usage

Add a workflow

name: Github Watcher

concurrency:
  group: ${{ github.workflow }} # allows only one run at a time

on:
  schedule:
    - cron: "*/5 * * * *" # every 5 minutes
  workflow_dispatch: # allows manual trigger

jobs:
  run-github-watcher:
    runs-on: ubuntu-20.04

    permissions:
      contents: read

    steps:
      - name: Checkout config file
        uses: actions/checkout@v4
        with:
          sparse-checkout: |
            .github/github-watcher-config.yaml
          sparse-checkout-cone-mode: false

      - name: Run
        uses: ovsds/github-watcher-action@v1
        with:
          config_path: .github/github-watcher-config.yaml
          env_variables: |
            GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}
            TELEGRAM_TOKEN=${{ secrets.TELEGRAM_TOKEN }}
            TELEGRAM_CHAT_ID=${{ secrets.TELEGRAM_CHAT_ID }}

Add a config file

tasks:
  - id: example_task
    triggers:
      - id: example_trigger
        type: github
        token_secret:
          type: env
          key: GITHUB_TOKEN
        owner: ovsds
        subtriggers:
          - type: repository_issue_created
          - type: repository_pr_created
          - type: repository_failed_workflow_run
    actions:
      - id: example_action
        type: telegram_webhook
        chat_id_secret:
          type: env
          key: TELEGRAM_CHAT_ID
        token_secret:
          type: env
          key: TELEGRAM_TOKEN

More information on config can be found in GitHub Watcher Config

Action Inputs

Name	Description	Default
`version`	Github Watcher version	`0.3.1`
`config_path`	Path to the config file
`env_variables`	Environment variables
`state_path`	Path to state directory, should be absolute and independent from the runner's workspace, otherwise cache will not work correctly	`/tmp/github-watcher-action/state`
`env_path`	Path to env file, that will be used to pass env_variables to the container	`.env`
`state_cache_prefix`	Cache prefix for state directory	`github-watcher-state`