Cloudflare PagesのDeployフックの仕様と使い方まとめ
公開日: 2021.8.19
新しく登場したCloudflare PagesのDeployフック。その仕様や具体的な使い方についてまとめました。
これまでのCloudflare Pagesのデプロイ
これまで、Cloudflare Pagesでビルド&デプロイするには、
- GithubレポジトリへのPush
- Cloudflare Pagesの管理ページから手動
の二つがありました。
基本的にこの二つの機能があれば、Cloudflare Pagesにサイトをデプロイするのに問題ないのですが、ヘッドレスCMSを使っている場合や、プログラムと連携させてデプロイしたい場合には、手動しか方法がなかったため、高度な使い方には制限がありました。
Cloudflare PagesのDeployフックの仕様
今回、Deployフック機能が追加されたことで、ヘッドレスCMSなどのサードパーティサービスや、オリジナルプログラムと組み合わせてDeployが出来るようになります。
Cloudflare PagesのDeployフックは、Cloudflare APIにPOSTリクエストを送る形になります。正しいパラメータでPOSTを送ると、ビルド&デプロイが開始されるという仕組みです。
POST方式なので、プログラムの言語やフレームワークに限定されることなく、様々な使い方ができます。
また、デプロイフックは複数作成可能なので、テストブランチ用やステージング用など使い分けをすると良いでしょう。
デプロイフック自体に回数制限はありませんが、Cloudflare Pages自体が一ヶ月に500回までのデプロイ制限があるので、あまり使いすぎないように注意しましょう。
Cloudflare PagesのDeployフック使い方
まずはCloudflareのサイトで、デプロイフックの設定をします。
- Pagesから対象のサイトに入る
- ページ上にあるタブメニューから「設定」に入る
- ページ左のメニューから「ビルド & デプロイ」に入る
- 「デプロイ フック」ブロックで設定を追加する
- APIのURLをコピーする
簡単ですね。
コピーしたURLは、
https://api.cloudflare.com/client/v4/pages/webhooks/deploy_hooks/乱数
というフォーマットになっています。「乱数」の部分がユニークな識別子になります。
このURLをプログラムなどからPOSTすれば、ビルド&デプロイが開始されます。試しに、curlでPOSTしてみましょう。
curl -X POST "https://api.cloudflare.com/client/v4/pages/webhooks/deploy_hooks/乱数"
下記のような値がかえってきて、successがtrueなら、デプロイが開始されているはずです。
{
"result": {
"id": "乱数"
},
"success": true,
"errors": [],
"messages": []
}
POSTするだけなので、WordPressに組み込んだり、自前のプログラムと連携も簡単です。
Cloudflare PagesのDeployフックの仕様と使い方を見て来ました。
シンプルですが、プログラムなどと組み合わせることでCloudflare Pagesがもっと使いやすくなるので、ぜひ試してみてください。
価格は記載がある場合を除き、すべて税込みです。
関連キーワード
サーバレスの新着記事
サーバレス複数サイト運営をする際の無料サーバー使いこなし術 2022.9.5
サーバレスHerokuの無料プランが終了へ。移行するならどこがいい? 2022.8.26
サーバレスCloudflare Pages Functionsをローカルでテストする方法 2022.8.12
サーバレスCloudfalre Pagesでリダイレクトを使う方法 2022.8.11
サーバレスCloudflare WorkersとCloudflare Pages Functionの違いと使い分け 2022.8.10
サーバレスCloudinaryの自分のデータを自動でバックアップさせる方法 2022.8.1
サーバレスいまさら聞けないレンタルサーバーとHerokuの違い 2022.5.10
サーバレスCloudflare Pagesでアクセス制限を実装する 2022.4.26