Skip to main content

GitHub Actions

The GitHub Actions trigger dispatches repository_dispatch events to your GitHub repositories when container updates are discovered, automating CI/CD pipelines, GitOps rollouts, or build workflows.

⚙️ Configuration Variables​

WUD_TRIGGER_GITHUBACTIONS_{trigger_name}_OWNER
Requiredstring

GitHub repository owner or organization (e.g. octocat)

WUD_TRIGGER_GITHUBACTIONS_{trigger_name}_REPO
Requiredstring

GitHub repository name (e.g. infrastructure)

WUD_TRIGGER_GITHUBACTIONS_{trigger_name}_TOKEN
Requiredstring

GitHub Personal Access Token (classic token with repo scope, or fine-grained PAT with Actions: Read and write permissions)

WUD_TRIGGER_GITHUBACTIONS_{trigger_name}_DISABLETITLE
Optionalbooleandefault: false

Whether to omit the notification title in payload

WUD_TRIGGER_GITHUBACTIONS_{trigger_name}_EVENTTYPE
Optionalstringdefault: wud-update

Custom event_type string matched by your workflow's on.repository_dispatch.types

WUD_TRIGGER_GITHUBACTIONS_{trigger_name}_URL
Optionalurldefault: https://api.github.com

GitHub API base URL (can be pointed to GitHub Enterprise Server)

info

This trigger also supports all common trigger configuration options (such as thresholds, scheduling, and batching).

📖 GitHub Actions Workflow Example​

Create a workflow file .github/workflows/wud.yml in your repository:

name: WUD Update Receiver

on:
  repository_dispatch:
    types: [wud-update]

jobs:
  on-update:
    runs-on: ubuntu-latest
    steps:
      - name: Inspect Payload
        run: |
          echo "Container: ${{ github.event.client_payload.container }}"
          echo "Image: ${{ github.event.client_payload.image }}"
          echo "New Tag: ${{ github.event.client_payload.remoteTag }}"

🚀 Examples​

Basic Repository Dispatch​

services:
  whatsupdocker:
    image: getwud/wud
    environment:
      - WUD_TRIGGER_GITHUBACTIONS_GITOPS_OWNER=myorg
      - WUD_TRIGGER_GITHUBACTIONS_GITOPS_REPO=gitops-repo
      - WUD_TRIGGER_GITHUBACTIONS_GITOPS_TOKEN=ghp_secrettoken1234567890
      - WUD_TRIGGER_GITHUBACTIONS_GITOPS_EVENTTYPE=wud-update