Cloudflare Pagesの設定をwrangler.tomlに出力する

2024年春のDeveloepr WeekでCloudflare Pagesがwrangler.tomlをサポートしたとアナウンスがありました。手元のアカウントにも、Pagesを利用しているサイトがありましたので、早速試してみました。

Wrangler CLIで設定を取得する

ダウンロードコマンドは非常にシンプルです。プロジェクト名はダッシュボードから確認するのが早そうです。

$ npx wrangler@latest pages download config <PROJECT_NAME>

コマンドを実行すると、wrangler.tomlファイルが生成されます。

 ⛅️ wrangler 3.47.1
-------------------
Success! Your project settings have been downloaded to wrangler.toml

すでにwrangler.tomlが存在する場合は、上書きしてよいかを確認されます。

 ⛅️ wrangler 3.47.1
-------------------
? Your existing `wrangler.toml` file will be overwritten. Continue? › (Y/n)

上書きしてくれますので、もしGitで管理したくない情報が含まれていた場合などでは、ダッシュボードやWranglerで設定を変更してからダウンロードし直すと良さそうです。

設定を見てみる

今回生成したwrangler.tomlはこのような中身でした。

# Generated by Wrangler on Fri Apr 05 2024 21:47:22 GMT+0900 (Japan Standard Time)
name = "PROJECT_NAME"
pages_build_output_dir = "dist"
compatibility_date = "2023-03-25"

[vars]
MICROCMS_API_KEY = "XXXX"
NODE_VERSION = "16"

[env.production]
compatibility_date = "2023-03-25"

  [env.production.vars]
  MICROCMS_API_KEY = "XXXX"
  NODE_VERSION = "16"

環境変数に設定していたAPIキーなどが出力されています。ついでに、NODE_VERSIONの更新を忘れていることも思い出させてくれました。

暗号化した環境変数は取得されない

ポイントとしては、暗号化して保存したものについてはダウンロードされないという点でしょうか。今回はtestという環境変数を事前にセットしてみたのですが、こちらはwrangler.tomlに含まれませんでした。

wrangler.tomlはgit commitするファイルだと個人的には認識しています。ですので、APIキーなどは原則として暗号化して保存する使い方をするのが良さそうです。

まとめ

念願のCloudflare Pagesでwrangler.tomlを利用できるようになるアップデートがアナウンスされました。しかもすでに作成済みのサイトについても、Wrangler CLIで設定をダウンロードできるようになっています。

注意点としては、APIキーなどを暗号化せずに環境変数に設定していた場合、その内容がwrangler.tomlに反映されることでしょうか。とはいえ後からでもダッシュボードにて暗号化の設定が行えますので、「この環境変数はGitで管理したくないな・・・」というものが見つかった場合は、暗号化してからもう一度ダウンロードしてみましょう。