Cloudflare Pagesへのデプロイ手段をGit統合からGitHub Actionsに変更した

Cloudflare Pagesへのデプロイ手段をGit統合からGitHub Actionsに変更した

今までの構成

Zola公式ドキュメントにあるCloudflare Pagesへのデプロイ手順を実行していた。

Cloudflare Pages | Deployment

GitHubのリポジトリをCloudflare Pagesに統合する方法だ。 ただ、これだと zola build しか出来ない。

Git統合の設定を解除しておく

私の場合は、GitHub側でアクセスするリポジトリから除外した。

Remove access | GitHub integration

GitHub Actionsで cloudflare/wrangler-action を使ってデプロイする

cloudflare/pages-action が v1.5.0 と廃止となり、 cloudflare/wrangler-action へ移行を推奨していた。

[DEPRECATED] Cloudflare Pages GitHub Action | GitHub

cloudflare/wrangler-action のREADMEに例が書かれていたので参考にした。

Deploy your Pages site (production & preview) | GitHub

設定した .github/workflows/deploy.yaml はこのようになった。

on:
  push:
    branches:
      - "main"

jobs:
  deploy:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      deployments: write
    name: Deploy to Cloudflare Pages from GitHub Actions
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup Zola
        uses: taiki-e/install-action@v2
        with:
          tool: zola@0.20.0
      - name: Setup cargo-make
        uses: actions-rs/cargo@v1
        with:
          command: install
          args: --debug cargo-make
      - name: Build
        uses: actions-rs/cargo@v1
        with:
          command: make
          args: build_gha
      - name: Deploy
        uses: cloudflare/wrangler-action@v3
        with:
          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
          command: pages deploy dist --project-name=dnfolio
          gitHubToken: ${{ secrets.GITHUB_TOKEN }}

個人サイトでは、開発サーバーの起動やコードのフォーマット、ビルドなどを cargo-make で実施している。 この環境でデプロイしたかったのもGit統合から移行した理由の一つ。

deploy.yaml の説明

それぞれのステップについて簡単に書く。

Setup Zola

Zola公式ドキュメントに書いてあるのをそのままコピペした。

Via Github Actions | Installation

- name: Setup Zola
  uses: taiki-e/install-action@v2
  with:
    tool: zola@0.20.0

taiki-e/install-action はZola以外にも対応してそうだったので気になった。

Setup cargo-make

cargo-make のREADMEを参考にした。

Github Actions | cargo-make GitHub

- name: Setup cargo-make
  uses: actions-rs/cargo@v1
  with:
    command: install
    args: --debug cargo-make

Build

cargo-make の書き方を参考にした。

- name: Build
  uses: actions-rs/cargo@v1
  with:
    command: make
    args: build_gha

このように書くことで cargo make build_gha を実行することになる。ちなみにこの build_gha は、プロジェクトルートにある Makefile.toml で設定している。

[tasks.build_gha]
command = "zola"
args = ["build"]

今はまだ zola build のみだが、今後複数のビルドを実行したいときに拡張しやすい。

Deploy

wrangler-action のREADMEを参考にした。

Deploy your Pages site (production & preview) | GitHub

- name: Deploy
  uses: cloudflare/wrangler-action@v3
  with:
    apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
    accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
    command: pages deploy dist --project-name=dnfolio
    gitHubToken: ${{ secrets.GITHUB_TOKEN }}

dist は、 zola build で出力するディレクトリ名にする。私の場合は、 config.toml で dist に設定しているが、デフォルトは public なので適宜変更する。

# デフォルト
output_dir = "public"

# 私の設定
output_dir = "dist"

Configuration | Zola

secrets.CLOUDFLARE_ACCOUNT_ID と secrets.CLOUDFLARE_API_TOKEN はGitHub Actionsを構築するリポジトリの設定から事前に準備する必要がある。

  1. GitHubのプロジェクトのリポジトリにアクセスする。
  2. リポジトリ名の下にある Settings を選択する。
  3. Secrets and variables > Actions > Secrets タブ内の New repository secret を選択する。
  4. 名前に CLOUDFLARE_ACCOUNT_ID 、値には自分の CloudflareアカウントID を指定する。 Get project account ID を参考にする。 Add secret で作成する。
  5. 手順4と同じように、名前にCLOUDFLARE_API_TOKEN 、値に Cloudflare APIトークン を指定する。 Generate an API Token を参考にする。 Add secret で作成する。

詳細はCloudflare Pagesのドキュメントに書かれている。

Add Cloudflare credentials to GitHub secrets | Cloudflare Docs

GITHUB_TOKEN はGitHubが自動で取得する。

おわりに

Git統合によるデプロイはとても簡単だった。 これまでCloudflare PagesでSvelteKitやNext.jsのデプロイを経験したがどれも簡単にデプロイ出来て気に入っていた。 しかし、デプロイ時にビルド以外の処理もしたいと思ったため今回移行することにした。 wrangler-action は、今後使っていこうと思っていたCloudflare Workersでも利用出来そう。キャッチアップ出来て良かった。 仕事で利用しているFirebaseやGoogle Cloudのドキュメントに比べると、個人的にCloudflare周辺のドキュメントは分かりやすい。

次はCloudflare Workersを触っていきたい！