【Netlify】本番・ステージ・開発ブランチごとに環境変数の値を設定&設定する際の注意点
eyecatch

2023-02-04

【Netlify】本番・ステージ・開発ブランチごとに環境変数の値を設定&設定する際の注意点

未分類

こんにちは!かわいちです。
今回はNetlifyを使った「本番・ステージ・開発ブランチごとに環境変数の値を設定&設定する際の注意点」についてまとめていきます。

前提

この例では、GitHubとNetlifyを連携しており、以下のブランチ構成としています。
【ブランチ構成(ブランチ名)】

  • 本番環境: main
  • ステージ環境: stg
  • 開発環境: dev


また、各ブランチごとのデプロイ設定(「Site settings」→「Build & deploy」→「Continuous deployment」→「Branches and deploy contexts」)が既にできていることを想定しています。
※ これについては、本記事では紹介しません。

完成形と設定手順

完成形

設定手順

1. Netlify(https://app.netlify.com/)へアクセス&ログインし、今回環境変数を追加する対象のサイトのダッシュボード画面を開く
2.「Site settings」→「Environment variables」をクリック
3. 「Add a variable」をクリック

4. 環境変数のキー名を「Key:」へ入力
5. 各ブランチごとに環境変数の値(Value)を入力するため、「Values」→「Different value for each deploy context」にチェック
6. 本番環境用の値を「Production」に入力
7. 開発環境用の値を「Branch deploys」に入力
8. ステージ環境用は「+ Add a branch value (optional)」→「Branch name」にステージ環境のブランチ名(例:stg)を入力 →「Value for branch」に値を入力
9. 最後に「Create variable」で追加

設定する際の注意点

開発ブランチの環境変数の設定がうまくできなかった例

1. 「+ Add a branch value (optional)」で、ステージ用(stg)と開発用(dev)をそれぞれ入力し、「Create variable」で追加しようとした
2. しかし、以下のエラーが出て、開発用(dev)の環境変数が設定できない
エラー内容: 「dev is a reserved branch keyword (these include: production, deploy-preview, branch-deploy, dev, branch, main, master)」

解決策

ブランチ名 dev の環境変数は「Branch Deploy」に入力する
(ブランチ名 dev はNetlify側で予約されているワードであるため)

以上です。 最後まで読んでいただきありがとうございました!

自己紹介

logo

かわいち

都内ではたらくWeb系エンジニアです! 普段から効率良く開発できるように心がけています。 また、趣味でもプログラミングをしており、モノづくりが好きです。 このブログでは、プログラミングに役立つコトを日々発信しています!