Skip to main content

Slack での GitHub の通知のカスタマイズ

Slack で GitHub の通知をカスタマイズする方法について説明します。

Slack チャネルに関連するアクティビティをサブスクライブし、プロジェクトにあまり役に立たないアクティビティからサブスクライブを解除することで、通知をカスタマイズできます。

既定で有効になっている通知

次の通知は既定で有効になっていますが、 /github unsubscribe owner/repo [event] コマンドを使用して無効にできます。

EventDescription
issues問題を開いた、閉じた、または再度開いた。
pulls新規またはマージされたプルリクエスト、ならびにレビューが準備完了としてマークされている下書きプルリクエスト。
commits既定ブランチ上の新規コミット。
releases公開されたリリース。
deployments展開の状態の更新。

既定で無効になっている通知

次の通知は既定で無効になっていますが、 /github subscribe owner/repo [event] コマンドを使用して有効にできます。

EventDescription
reviewsプルリクエストレビュー
workflowsアクション ワークフローが実行されます。
branchesブランチを作成または削除しました。
comments問題とプルリクエストに関する新しいコメント。
commits任意のブランチへのすべてのコミット。
discussionsディスカッションが作成または回答されました。
+label:"your label"ラベルに基づいて、イシュー、プルリクエスト、コメントを管理します。

一度に複数の設定を登録または解除できます。 例えば次が挙げられます。

  • pull request レビューとコメントのアクティビティを有効にするには、 /github subscribe owner/repo reviews commentsを使用します。
  • 問題と pull request のアクティビティをオフにするには、 /github unsubscribe owner/repo issues pullsを使用します。

通知のフィルター処理

分岐フィルターとラベル フィルターを使用して、通知をさらにカスタマイズできます。 ブランチ フィルターを使用すると、ブランチ名に基づいてコミット通知をフィルター処理できますが、ラベル フィルターを使用すると、問題をフィルター処理したり、それらに適用されたラベルに基づいて要求通知をプルしたりできます。

コミット通知の分岐フィルター

ブランチ フィルターを使用すると、ブランチ名に基づいてコミット通知をフィルター処理できます。 既定では、 commits イベントをサブスクライブすると、既定のブランチの通知が表示されます。 ただし、特定のブランチ、ブランチのパターン、またはすべてのブランチを基準としてフィルター処理を選択できます。

構成例Description
/github subscribe owner/repo commits既定のブランチのコミット通知を受信します。
/github subscribe owner/repo commits:main
          `main` ブランチのコミット通知のみを受信します。|

|/github subscribe owner/repo commits:feature/*| feature/で始まるすべてのブランチのコミット通知を受け取ります。| |/github subscribe owner/repo commits:*|すべてのブランチのコミット通知を受信します。|

メモ

以前に、 commits:all フィルターを使用して、すべてのブランチのコミット通知を受信している可能性があります。 このフィルターは 終了 です。 すべてのブランチのコミット通知を受信するには、代わりに commits:* フィルターを使用します。 commits:all フィルターを以前に設定している場合は、commits:* フィルターを使用するように構成を更新するまで引き続き動作します。

問題とプルリクエストの通知に対するラベルフィルター

ラベル フィルターを使用すると、問題やプル要求に適用されたラベルに基づいて通知をフィルター処理できます。 ラベル フィルターを設定すると、指定したラベルを含むイベントの通知のみが送信されます。 ラベルの詳細については、「 ラベルを管理する 」と 「AUTOTITLE」を参照してください。

現時点では、リポジトリごとに必要なラベル フィルターを 1 つだけ持つことができます。 次の表は、ラベル フィルターの影響を受けるイベントの種類を示しています。

イベントの種類ラベルでフィルタリングされています
Pull Request
問題
Comments
Reviews
コミット/プッシュ
支店

ラベル フィルターの作成

ラベル フィルターを作成するには、次のコマンド形式を使用します。

Text
/github subscribe [owner/repo] +label:"your label"

これにより、 your label値を持つ必須ラベル フィルターが作成されます。 フィルターをサポートする受信イベントは、そのラベルがない限り破棄されます。

ラベル フィルターの更新

新しいラベル値を指定することで、既存のラベル フィルターを更新できます。

Text
/github subscribe [owner/repo] +label:"new label"

これにより、「あなたのラベル」フィルターが「新しいラベル」フィルターに置き換わります。

ラベル フィルターの削除

          `+label` オプションを指定して unsubscribe コマンドを使用して、既存のラベル フィルターを削除できます。
Text
/github unsubscribe [owner/repo] +label:"new label"

これにより、"新しいラベル" フィルターが削除され、チャネルは、ラベルのフィルター処理なしでサブスクライブされたイベントのすべての通知を受け取ります。

アクティブなラベル フィルターの表示

チャネルの現在アクティブなラベル フィルターを表示するには、次のコマンドを使用します。

Text
/github subscribe list features

有効なフィルター

Slack の GitHub アプリは、Slack と GitHub が標準として提供するすべての絵文字を含む、ラベル フィルターの最も一般的な特殊文字をサポートしています。 サポートされていない特殊文字を含むラベルが表示されることはほとんどありません。 たとえば、 :foo:としてエンコードされていないマルチバイト文字や、 , 文字を使用するラベルが期待どおりに機能しない場合があります。

アクションワークフロー通知

GitHub Actions のワークフロー実行通知は、"ワークフロー"機能を使用して、/github subscribe owner/repo workflows形式でチャネルまたは個人用アプリから登録できます。

"ワークフロー" をサブスクライブしている場合は、次の機能を使用できます。

  • 新しいワークフロー実行がトリガーされると、通知が表示されます。

  • スレッドで承認通知を返信として追跡でき、チャネル/個人用アプリから直接通知を承認できます。

  • ワークフローが完了すると、スレッドでワークフローの実行に関するコンテキストと履歴を確認できるように、新しい情報が届きます。

  • 何かが失敗した場合は、ワークフローを再実行することを選択できます。また、必要に応じてデバッグ ログを有効にすることもできます。

メモ

2025-03-10 (GHES バージョン 3.17) 以降、個々のワークフロー ジョブの進行状況は通知されなくなります。 詳細については、 GitHub の変更ログ を参照してください。

ワークフロー通知フィルター

ワークフロー通知をフィルター処理するには、次のオプションを使用します。

FilterDescription
nameワークフローの名前でフィルター処理します。
actorワークフローを開始したユーザーによってフィルタリングします。
branchワークフローが実行されているブランチでフィルター処理します。
          `pull_request` イベントが含まれている場合、ブランチはプル要求が作成されるターゲット ブランチになります。|

|event|ワークフローをトリガーしたイベント (プッシュ、pull_requestなど) でフィルター処理します。|

ワークフロー通知フィルターは、次の形式で構成できます。

Text
/github subscribe owner/repo workflows:{name:"your workflow name" event:"workflow event" branch:"branch name" actor:"username"}

コンマで区切って、フィルターごとに複数の値を渡すこともできます。 例えば次が挙げられます。

Text
/github subscribe owner/repo workflows:{name:"your workflow name","another workflow name" event:"workflow event","another workflow event" branch:"branch name","another branch name" actor:"username","another-username"}

既定では、フィルターを渡さずにワークフロー通知を構成すると、既定のブランチを対象とするプル要求によってトリガーされるワークフロー用に構成されます。 1 つまたは複数のエントリを渡すことができます。

ワークフロー通知の登録を解除するには、次のコマンドを使用します: /github unsubscribe owner/repo workflows

メモ

SlackでGitHub Actionsの通知を受け取るには、GitHubアプリに追加の権限が必要です。 ワークフローを初めてサブスクライブしようとすると、これらのアクセス許可を付与するように求められます。

デプロイ通知

個別のデプロイ通知を構成することもできます。 これらのデプロイは、GitHub Actions から、またはデプロイ API を使用して外部ソースから行うことができます。 「デプロイ用の REST API エンドポイント」を参照してください。

          `/github subscribe/unsubscribe owner/repo deployments`コマンドを使用して、デプロイ通知のサブスクライブ/サブスクライブ解除を行うことができます。

メモ

GitHub Actions を使用していて、環境へのデプロイを追跡する場合は、 workflows 機能をお勧めします。これは、より完全な画像と、Slack から直接デプロイを承認する機能を提供するためです。