GitHub Actions

完了したワークフローで スマホを震わせましょう。

Pocket Alert は、GitHub Actions の結果をプッシュ通知としてスマホに送信します。ワークフローに curl のステップを 1 つ追加するだけで、ビルド・デプロイ・リリースが完了した瞬間に、結果が iPhone や Android に 1 秒以内に届きます。Actions のタブを見守る必要はありません。

1 秒未満で配信キーはシークレットで管理curl のステップを 1 つ追加 更新
機能

ワークフローの実行からロック画面まで

ワークフローは、ジョブが完了したタイミングをすでに把握しています。Pocket Alert は、その瞬間を見逃せないプッシュ通知に変えます。

ワークフローに 1 ステップ追加するだけ

メッセージ API に対する 1 回の curl 呼び出しで、どのワークフローのステップでもプッシュ通知に変えられます。ランナーの設定や追加サービスは不要です。

リポジトリシークレットとしてキーを管理

${{ secrets.POCKETALERT_API_KEY }} から API キーを読み込むので、ログに出力されず、ダッシュボードからローテーションできます。

必要な結果だけ通知

if: failure() と if: success() を組み合わせると、ビルド失敗とデプロイ成功を、それぞれわかりやすいラベル付きの別々のメッセージとして送信できます。

リポジトリごとのチャンネル

アプリケーションごとに ID があるため、リポジトリごとや環境ごとの実行を別々のチャンネルで管理できます。

1 秒未満で配信

ジョブが終了した瞬間にステップが実行されるため、結果は 1 秒以内にスマホへ届きます。

実行の詳細情報を完全に含める

github.repository、github.sha、github.workflow をメッセージに含めると、どの実行の結果かが正確にわかります。

はじめ方

スマホで GitHub Actions の通知を受け取る 3 つのステップ

1

アプリケーションを作成

Pocket Alert でアプリケーションを追加し、API キーを POCKETALERT_API_KEY というリポジトリシークレットとして保存します。

2

ステップを設定

メッセージ API に curl を送る通知ステップを追加し、if: failure() と if: success() で通知する結果を選びます。

3

マッピングして送信

リポジトリ名、sha、ワークフロー名をメッセージに含めます。次の実行から、スマホが震えるようになります。

GitHub Actions の通知をスマホに送る

1. アプリケーションを作成して API キーを保存する

Pocket Alert でアプリケーションを追加し、API キーをコピーしてください。設定 → Secrets and variables → Actions で、POCKETALERT_API_KEY という名前でリポジトリシークレットとして保存します。

2. メッセージ API を呼び出す通知ステップを追加する

- name: Notify on failure
  if: failure()
  run: |
    curl -X POST "https://api.pocketalert.app/v1/messages" \
      -H "Token: ${{ secrets.POCKETALERT_API_KEY }}" \
      -H "Content-Type: application/json" \
      -d '{"title":"Build failed","message":"${{ github.workflow }} on ${{ github.ref_name }} (${{ github.sha }})","level":"high"}'

- name: Notify on success
  if: success()
  run: |
    curl -X POST "https://api.pocketalert.app/v1/messages" \
      -H "Token: ${{ secrets.POCKETALERT_API_KEY }}" \
      -H "Content-Type: application/json" \
      -d '{"title":"Deploy succeeded","message":"${{ github.repository }}@${{ github.sha }}"}'

3. 特定のアプリケーションに送信する

ボディに application_id を追加すると、1 つのアプリに通知を送信できます(TID はダッシュボードで確認できます):

-d '{"title":"Release shipped","message":"${{ github.repository }} ${{ github.ref_name }}","application_id":"qm47b9pzxzxg"}'

メッセージ API で指定できるフィールドはすべて、はじめに のドキュメントに記載されています。

FAQ

よくある質問

Token ヘッダーに API キーを指定して https://api.pocketalert.app/v1/messages に対して curl を実行するステップを追加してください。ジョブの最後に配置すると、デプロイ完了やビルド失敗がそのままスマホに届きます。

API キーはリポジトリのシークレットとして保存し、${{ secrets.POCKETALERT_API_KEY }} で読み込んで Token ヘッダーに設定してください。キーがログに表示されることはなく、Pocket Alert のダッシュボードからローテーションできます。

2 つのステップにそれぞれ if: failure() と if: success() を指定してください。ビルド失敗とデプロイ成功で別々のメッセージが届くので、必要な結果だけを通知できます。

リポジトリや環境ごとにアプリケーションを作成してください。フロントエンド、バックエンド、リリースのワークフローがそれぞれ別のチャンネルに届くので、個別にミュートできます。

メッセージ本文に ${{ github.repository }}、${{ github.sha }}、${{ github.workflow }} などの実行コンテキストを含めると、どの実行が完了したのかがプッシュ通知で正確にわかります。

このステップは Token ヘッダーと、title と message を含む JSON ボディを付けて https://api.pocketalert.app/v1/messages を呼び出します。特定のアプリに送信するには application_id を追加してください。

失敗時のステップのボディに "level":"high" を追加すると、iPhone では集中モードを貫通し、Android では目立つ形で通知されます。"level":"critical" を指定すると、おやすみモードも無視されます。デプロイ成功の通知は "level":"silent" にすると、振動せずに履歴へ残せます。

実行を見守らなくても、デプロイの成功がすぐわかります。

アプリケーションを作成して API キーを取得し、Pocket Alert のステップをワークフローに追加してください。