본문으로 건너뛰기

GitHub Actions

단계 템플릿을 사용해 CI/CD 워크플로 진행 상황을 Lock Screen에서 실시간으로 추적하세요.

Live Activity 시연

How It Works

The pushward-github bridge container polls the GitHub Actions API for in-progress workflow runs and maps workflow progress to Live Activities using the steps template.

  1. Idle polling -- checks all configured repos every 60s for in-progress workflows
  2. Active tracking -- when a run is detected, polls jobs every 5s and updates progress
  3. Cleanup -- after the workflow completes, the activity is cleaned up after a configurable delay (default 15 min)

Setup

1. Get Your Integration Key

PushWard 앱을 열고 → 설정 → 연동 키에서 기본 hlk_ 키를 확인하세요.

이 연동을 위한 전용 키를 생성하려면:

  1. 설정 → 키 관리로 이동하세요
  2. +를 탭하세요
  3. 이름을 설정하고(예: "GitHub Actions"), 선택: , 범위를 선택한 다음 선택적으로 activity 슬러그로 제한하세요
  4. 생성된 hlk_ 키를 복사하세요

2. Create a GitHub Personal Access Token

Create a fine-grained PAT with actions:read permission on the repos you want to track.

3. Deploy the Bridge

docker-compose.yml
services:
  pushward-github:
    image: ghcr.io/mac-lucky/pushward-github:latest
    environment:
      PUSHWARD_URL: https://api.pushward.app
      PUSHWARD_API_KEY: hlk_YOUR_INTEGRATION_KEY
      PUSHWARD_GITHUB_TOKEN: ghp_YOUR_GITHUB_TOKEN
      PUSHWARD_GITHUB_OWNER: your-username  # auto-discovers all repos
      # OR specify repos explicitly:
      # PUSHWARD_GITHUB_REPOS: owner/repo1,owner/repo2
    restart: unless-stopped

Configuration

환경 변수설명기본값
PUSHWARD_URLPushWard server URL--
PUSHWARD_API_KEYIntegration key (hlk_ prefix)--
PUSHWARD_GITHUB_TOKENGitHub PAT with actions:read--
PUSHWARD_GITHUB_OWNERGitHub username for auto-discovery--
PUSHWARD_GITHUB_REPOSComma-separated owner/repo list--
PUSHWARD_PRIORITYActivity priority (0-10)1
PUSHWARD_POLL_IDLEIdle poll interval60s
PUSHWARD_POLL_ACTIVEActive poll interval5s
PUSHWARD_CLEANUP_DELAYDelay before cleanup after ended15m
💡

Use PUSHWARD_GITHUB_OWNER to auto-discover all your repos. The bridge refreshes the repo list every 5 minutes, skipping archived and disabled repos.

Activity Slug Format

Activities are created with the slug gh-{repo-name} (e.g. gh-pushward-server). One run is tracked per repository at a time.