microCMS

GitHub ActionsへのWebhook通知に対応しました

更新情報
2020/03/18 松田 承一

みなさんこんにちは、ウォンタ株式会社代表取締役の松田です。
本日のmicroCMSの更新情報をお知らせします。

GitHub ActionsへのWebhook通知に対応しました

GitHub公式のCI / CDツールであるGitHub ActionsへのWebhook通知に対応しました。
これによりAPIやコンテンツの更新時にGitHub Actionsのビルドを簡単に開始することができるようになりました。

GitHub Actions連携を設定するにはまず、API設定の「Webhook」を開いてください。

画面内に「追加」というボタンがあるのでこれを押すと、GitHub Actionsを新たに選択できるようになっています。

今回追加したWebhook機能はRepository Dipatchイベントに対応しており、設定を行うには以下の4つの情報が必要です。
Repository Dispatchイベントについては公式サイトなどをご確認ください。

  • GitHub Token
  • リポジトリユーザ名
  • リポジトリ名
  • トリガーイベント名:こちらでyml設定ファイルに記載したtypes属性の値を指定します。


上記の各設定値を入力できたら、Webhook通知を行うタイミングを設定して保存します。
設定の完了以降は指定したタイミングでGitHub Actionsのdispatchイベントが発火しビルドが開始されるようになります。

なお、dipatchイベント呼び出し時のclient_payloadには以下のようなサービス・API・コンテンツの各情報が渡されますので必要に応じてビルド処理内でご利用ください。

{
    "service": "your_service",
    "api": "news",
    "id": "RX252Zoo7",
    "draftKey": "2Jnt22mLh5",
    "type": "new"
}

※draftKeyはコンテンツが下書き、もしくは予約公開状態の場合にのみ含まれます
※typeには新規(new)、編集(edit)、削除(delete)の3つの値のいずれかが含まれます

少し複雑な設定値となりますので、お困りの場合は画面右下のチャットなどからお気軽にお問い合わせください!

おわりに

GitHub ActionsへのWebhook通知についてお知らせしました。
昨今のWebやアプリの開発業界ではインフラやCI / CDツールの進化なども凄まじいものがあります。
microCMSもそういった様々なツールとの連携を今後ともスムーズにしていきたいと考えています。
追加で対応した方が良いサービス等ありましたらぜひ教えてください!

-----

microCMSは日々改善を進めています。
ご意見・ご要望は管理画面右下のチャット、公式Twitterメールからお気軽にご連絡ください!
引き続きmicroCMSをよろしくお願いいたします!

ABOUT ME

松田 承一
ウォンタ株式会社の代表 / 家族=👨‍👩‍👧 / ヤフー→大学教員など→現職 / 管理画面付きAPIがすぐに作れるmicroCMSというサービス作ってます。