github-actions-slack-notify

name	github-actions-slack-notify
description	shiguredo/github-actions リポジトリの Slack Notify Composite Action の開発・修正・レビュー。入力パラメータ、notify_mode、Fixed 通知、色判定、フィールド制御、ペイロード構築、テストワークフローに関する質問で使用。

Slack Notify Composite Action

shiguredo/github-actions リポジトリで提供される Slack 通知用 Composite Action。

リポジトリ構成

• アクション定義: .github/actions/slack-notify/action.yml
• テストワークフロー: .github/workflows/test-slack-notify.yml
• rtCamp/action-slack-notify の互換実装 (Docker レス)

使い方

slack-notify:
    needs: ci
    if: always()
    runs-on: ubuntu-slim
    timeout-minutes: 5
    permissions:
      actions: read
    steps:
      - uses: shiguredo/github-actions/.github/actions/slack-notify@main
        with:
          status: ${{ job.status }}
          slack_webhook: ${{ secrets.SLACK_WEBHOOK }}
          slack_channel: ruri
          notify_mode: failure_and_fixed
        env:
          GH_TOKEN: ${{ github.token }}

プライベートリポジトリの場合はコミットメッセージ取得のために contents: read 権限を追加する:

    permissions:
      actions: read
      contents: read

入力パラメータ

名前	必須	デフォルト	説明
status	必須	-	ジョブステータス (job.status を渡す。別ジョブの失敗・キャンセルは自動検出)
slack_webhook	必須	-	Slack Incoming Webhook URL
slack_channel	必須	-	Slack チャネル名 (# なし)
slack_title	-	''	メッセージタイトル (空なら自動生成: コミットメッセージ)
slack_message	-	''	メッセージ本文
slack_color	-	''	色の手動指定 (指定時は自動判定を上書き)
slack_username	-	GitHub Actions	ボット名
slack_icon_emoji_success	-	:large_green_circle:	Success 時のボットアバター
slack_icon_emoji_failure	-	:red_circle:	Failure 時のボットアバター
slack_icon_emoji_fixed	-	:large_blue_circle:	Fixed 時のボットアバター
slack_footer	-	Powered by shiguredo/github-actions	フッター
msg_minimal	-	''	true で最小表示、カンマ区切りで個別指定 (repository,workflow,ref,event,commit)
notify_mode	-	failure_and_fixed	通知モード

notify_mode

モード	動作
all	全ステータスで通知
failure_and_fixed	failure と fixed のみ
failure_only	failure のみ
success_only	success のみ

スキップ時はログにステータスや前回結論を出力する:

• failure_only: 通知をスキップ (ステータス=success)
• failure_and_fixed: 通知をスキップ (ステータス=success, 前回結論=success, fixed=false)
• success_only: 通知をスキップ (ステータス=failure)

処理フロー

1. ステータスを小文字に正規化
2. 別ジョブから呼ばれた場合の失敗検出 (gh api で同一ワークフロー実行内の他ジョブの結果を確認)
3. gh run list で前回のワークフロー実行結果を取得 (Fixed 判定用)
4. re-run (attempt > 1) の場合、前回 attempt の結果で Fixed 判定
5. notify_mode に基づく送信スキップ判定 (スキップ時はステータス・前回結論・fixed 判定結果をログ出力)
6. 色の決定 (手動指定 > 自動判定)
7. ステータステキスト決定 (Fixed / Success / Failure / Cancelled)
8. ステータス別アイコン絵文字の選択
9. タイトル・メッセージ生成
10. msg_minimal に応じたフィールド配列構築
11. jq -n で安全に JSON ペイロード生成
12. curl で Slack Webhook に POST
13. HTTP ステータスコード確認

ステータス別アイコン絵文字

• ステータス (Success / Failure / Fixed) に応じて異なるボットアバター絵文字を表示
• Slack Incoming Webhook の icon_emoji はカスタム絵文字に非対応。標準 Slack 絵文字のみ使用可能
• 連続投稿時は Slack がメッセージをグループ化し、最初のメッセージのアバターのみ表示される

Fixed 通知

• 条件: 同一ワークフロー・同一ブランチで前回 failure かつ 今回 success
• re-run の場合: 前回 attempt が failure かつ今回 attempt が success でも Fixed と判定
• gh run list --workflow --branch --status completed --limit 10 で前回結果を取得 (現在の実行を databaseId で除外)
• 前回結論 (PREV_CONCLUSION) の値: 具体値 (success, failure 等) / none (初回実行) / unknown (API 失敗)
• re-run 時は gh api で前回 attempt の conclusion を確認 (github.run_attempt > 1 の場合)
• 色: #2196F3 (青)
• ステータステキスト: Fixed
• actions: read 権限が必要 (gh run list のため)
• 同時実行で判定が不正確になる可能性があるため、ワークフローに concurrency の設定を推奨

全 skipped 時のジョブスキップ

• Composite Action の内部から自身のジョブを skipped 状態にはできない (GitHub Actions の仕様上、ジョブのスキップ判定はジョブ実行前の if: でのみ行われる)
• Composite Action 側で exit 0 してもジョブは success として完了するため、ワークフロー全体が緑に見えて実態と乖離する
• 全 skipped 時に通知ジョブもスキップしたい場合は、呼び出し側のワークフローで if: に needs.*.result != 'skipped' を列挙する
• Composite Action 側では「全 skipped」を特別扱いしない (ステータス判定は failure / cancelled のみを上書き、それ以外は status 入力をそのまま使用)

色の自動判定

条件	色
slack_color 指定済み	指定値
success + 前回 failure (Fixed)	#2196F3
success	good
failure	danger
その他	#808080

フィールド制御 (msg_minimal)

• 空: 全フィールド (Repository, Workflow, Ref, Event, Commit, Status)
• true: Status のみ
• カンマ区切り (例: ref,commit): 指定フィールド + Status

テストワークフロー

test-slack-notify.yml は workflow_dispatch で手動実行する。

入力:

• force_failure (boolean): 意図的にジョブを失敗させる
• notify_mode (choice): failure_and_fixed / all / failure_only / success_only
• slack_channel (string): 通知先チャネル (# なし)

必要な権限: actions: read runs-on: ubuntu-slim

rtCamp/action-slack-notify との差異

• Docker レス (Composite Action) のため起動が高速
• status 入力を追加 (rtCamp は環境変数 SLACK_COLOR で job.status を渡す)
• notify_mode を追加 (all / failure_and_fixed / failure_only / success_only)
• Fixed 通知機能を追加 (前回 failure → 今回 success の自動検知)
• 環境変数ではなく with で入力を渡す
• jq で安全に JSON を構築 (rtCamp は Go / シェル文字列連結)

実装上の注意

• actions/checkout 不要 (コミットメッセージは GitHub API で取得)
• 通知専用の別ジョブとして実行することを推奨
• 環境変数経由でパラメータを受け取る (env: で INPUT_* にマッピング)
• GH_TOKEN を env で渡す必要がある (gh run list / gh api のため)
• actions: read 権限が必要 (gh run list による Fixed 判定のため)
• contents: read 権限はプライベートリポジトリでのみ必要 (コミットメッセージ取得の gh api /repos/{owner}/{repo}/commits/{sha} のため)
  • パブリックリポジトリではコミット情報が公開データのため contents: read なしでも動作する
  • プライベートリポジトリでは contents: read がないと 403 エラーになりコミットメッセージが取得できない
  • 権限不足時はコミットメッセージが空文字にフォールバックし、タイトルが空欄になるが通知自体は送信される
• GITHUB_*_VAL で GitHub コンテキスト値を渡す (シェル内での式展開を避ける)
• set -euo pipefail で厳密なエラーハンドリング
• gh api のエラーハンドリング: gh api は HTTP エラー時にエラー JSON を標準出力に出力するため、コマンド置換でキャプチャするとエラー JSON が混入する。if ! 構文で終了コードを判定し、失敗時はデフォルト値にフォールバックさせる
• jq -n による安全な JSON 生成 (シェルインジェクション防止)
• HTTP ステータスコードが 200-299 以外の場合は ::warning:: で通知