Firebase HostingのデプロイをWebhook(API)経由で行う

公開日時

前回の記事でCloud BuildでFirebase Hostingのデプロイを行うようにした。

今回はCloud BuildのトリガーにWebhookを設定して、Webhook(API)経由でFirebase Hostingへのデプロイが行えるようにする。

cloud build

トリガーの設定は公式ドキュメントに沿って進めていく。

なお、Webhookトリガーはまだプレビュー版となっており、今後手順が変わる可能性もあるので注意。

事前対応

  • Cloud Build and Secret Manager API を有効にする
  • 認証情報ページでAPIキーを作成
    • APIの制限で「Cloud Build API」のみ有効にした
cloud build webhook api key

Cloud Buildでの対応

  • トリガー => トリガーを作成
  • イベントの「Webhookイベント」にチェック
  • シークレットを新規作成
cloud build webhook api secret
  • Webhook URLのプレビューに記載されているURLをメモしておく
https://cloudbuild.googleapis.com/v1/projects/<project_id>/triggers/<trigger_name>:webhook?secret=<SECRET_KEY>&key=<API_KEY>
  • 構成 => 形式 => Cloud Build 構成ファイル(yaml または json)

Webhook経由でデプロイを実行

Webhook URLに対しPOSTリクエストを投げるとCloud Buildが実行される。

curlだと↓のようになる。

curl -v -XPOST -d '{}' -H 'Content-Type: application/json' 'https://cloudbuild.googleapis.com/v1/projects/<project_id>/triggers/<trigger_name>:webhook?secret=<SECRET_KEY>&key=<API_KEY>'

これでWebhook(API)経由でFirebase Hostingへのデプロイが行えるようになった。

最終的にはこのAPIをCloud Function等で呼び出せるようにして、サイト上に設置したデプロイボタンをトリガーにデプロイできるようにした。

Webhook経由でのデプロイはなかなか便利。

補足

Github Actionsでも workflow_dispatch を使うと同じようなことはできそうだが、API呼び出しの際にPersonal Access Tokenを付与する必要がある。

Personal Access Tokenの場合、全リポジトリに対する権限しか設定できないため権限が強すぎると判断して今回はCloud Buildを利用した。

Cloud Buildの場合は↓となっており、Github ActionsのWebhookよりも厳密な権限管理ができる。

  • Webhook呼び出しの際にはプロジェクト専用に作成したAPIキーとシークレットを利用している
  • Build時に使用するGitHubのトークンについてはCloud Build GitHubアプリに対して許可したリポジトリのみが対象となっている

参考


Related #firebase

YouTubeの「Firebase Release Notes」プレイリスト

最新のアップデートの概要を把握するのにちょうど良い

Firebase Extensions

Functionsを実装する際の参考になる

Cloud FunctionsでFirebase Authenticationの認証情報を取得する

functions.https.onCallを使用している場合はcontextパラメータを受け取ることができる

Nuxt.jsのservice workerで環境変数を切り替えられるようにする

設定情報をハードコードしたくなかったので、ビルド時にnodeコマンドでファイル生成を行い環境変数を切り替えられるように対応した。

CloudFunctionsを使ってFirestoreのサブコレクションを削除する

CloudFunctions内でFirebase CLIのdeleteコマンドを呼び出すことで一括削除ができる