Skip to content

Latest commit

 

History

History
55 lines (32 loc) · 2.51 KB

README_notify.md

File metadata and controls

55 lines (32 loc) · 2.51 KB

リリース時にSlackに通知するワークフロー

notify.ymlはGitHubのreleaseイベントをトリガーに、ビルドの成功を通知するワークフローです.

pre-releaseの場合は通知しないようにして、pre-releaseを後から外した時にactionが走ってくれると最高.

とのことなので、

  1. releaseする
  2. pre-releaseした後、pre-releaseを外す

の時に発火するよう設定しています。

セットアップ時に必要なこと

前提として、通知先のチャンネル通知するSlack Appが必要です。

Slackへの通知にはIncoming Webhookを使用しており、通知先チャンネルのWebhook URLが必要なので一応説明しておきます。

1. Slack Appを作成

Your appsから作成できます。

2. Webhook URLを取得

Appを作成したら、Add New Webhook to Workspaceから通知先チャンネルのWebhook URLを取得してください。

curl -X POST -H 'Content-type: application/json' --data '{"text":"Hello, World!"}' <取得したWebhook URL>

を実行すると、連絡先チャンネルにHello, World!のメッセージが投稿されるはずです。

3. SecretsにWebhook URLを保存

作成した総会リポジトリのSettings > Secrets > New repository secretからWebhook URLを保存できます。この時、Name属性は必ずSLACK_WEBHOOKにしてください。

投稿メッセージのカスタマイズ

以上の作業を終えると、下記のようなメッセージが投稿されることになります。

スクリーンショット 2021-08-27 12 47 42

Messageというテキストを変更したい場合は、.github.sample/workflows/notify.ymlを下記のように変更してください。

  env:
+   SLACK_TITLE: "タイトルを記入するよ"
    SLACK_MESSAGE: ":tada: 総会文書がリリースされました"
    SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}

詳しくはaction-slack-notify