GitHub Actions

steps テンプレートを使って、CI/CD ワークフローの進捗を Lock Screen でリアルタイムに追跡します。

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」）、選択：, スコープを選択し、任意で限定する対象：アクティビティスラッグ
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

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

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.