ドキュメントを開く +

GitHub Actions

自動化したワークフローから通知を受信。

BREEZE_SERVER に https://push.breezelabs.dev を設定し、キーを環境シークレット BREEZE_WEBHOOK_KEY に保存してください。

対象リポジトリに Actions secret BREEZE_WEBHOOK_KEY を作成し、送信用の key だけを保存します。次のワークフローは手動実行で動作を確認できます。リポジトリを自動変更したり、追加の権限を要求したりする処理は含まれていません。

yaml
name: Send Breeze notification
on:
  workflow_dispatch:
permissions: {}
jobs:
  notify:
    runs-on: ubuntu-24.04
    timeout-minutes: 1
    env:
      BREEZE_SERVER: https://push.breezelabs.dev
      BREEZE_WEBHOOK_KEY: ${{ secrets.BREEZE_WEBHOOK_KEY }}
    steps:
      - name: Send notification
        shell: bash
        run: |
          test -n "$BREEZE_WEBHOOK_KEY"
          curl --silent --show-error --fail-with-body \
            --connect-timeout 5 --max-time 20 \
            "$BREEZE_SERVER/v1/send" \
            -H "Authorization: Bearer $BREEZE_WEBHOOK_KEY" \
            -H 'Content-Type: application/json' \
            --data-binary '{"title":"GitHub Actions","message":"通知ワークフローを実行しました","thread_id":"github-actions"}'

本番のスクリプトではレスポンスも解析し、207 や 429 などに応じた処理を定めてください。curl --fail-with-body は主に 4xx / 5xx をエラーとして扱うため、207 は失敗になりません。issue やコミットメッセージなどの外部テキストを shell や JSON に直接連結せず、先に JSON としてシリアライズしてください。secret の設定と適用範囲については、GitHub 公式ドキュメントを参照してください。

送信結果と再試行の注意点