Webhookを利用して、コンテンツの更新時にGatsby Cloudでデプロイを行う

このチュートリアルでは、Webhook を利用して、コンテンツの更新時に Gatsby Cloud でビルド・デプロイを行う手順を紹介します。

前提条件

  1. デプロイを行うGitリポジトリは既にGatsby Cloudに接続されていること
  2. Gitリポジトリを介してGatsby Cloudへのデプロイが成功していること

GitリポジトリのGatsby Cloudへの接続についてはGatsby Cloudの Create a Site from a Repository のドキュメントをご確認ください。
リポジトリの接続後、ビルドやデプロイが失敗する場合は設定に問題ないか、Gatsby Cloudの Managing Environment Variables のドキュメントや Using custom build scripts のドキュメントをご確認ください。

概要

Gatsby Cloudの Build Webhook を利用します。
Build Webhookとは、本番環境用のビルドをトリガーするためのURLで、このURLにリクエストを送ることで、自動でデプロイを実行できます。

1. Build Webhookを確認する

Gatsby Cloudの管理画面に入り、Site Settings > General のページから「Webhook」のセクションを探します。
「Builds webhook」のURLを確認します。

gatsby_webhook.jpg

2. Webhookを作成する

次にNewtの管理画面に入り、スペース設定 > Webhook のページから「Webhookを作成」を押し、「Webhookテンプレート」を選択します。
「Gatsby Cloud」のテンプレートを選んだ後、ステップ1で作成したURLを入力し、Webhookを作成します。

webhook_gatsby_cloud1.jpg

以上で設定は終了です。
一部のコンテンツが更新された時にのみ、Webhookをトリガーする場合は、Webhookの編集画面に入り、「通知対象にするモデル」を指定してください。

これで、通知対象のコンテンツの公開・非公開が変更された時、および公開コンテンツの更新時にリクエストが送信され、Gatsby Cloudでビルド・デプロイが実行されます。

Newt Made in Newt