Vercelの環境変数、ビルドコマンド、Production Branchの設定

記事タイトルとURLをコピーする

こんにちは、アプリケーションサービス部ディベロップメントサービス1課の外崎です。

今回は、Vercelのビルドコマンド設定、環境変数の設定、ブランチのカスタマイズについて詳しく解説します。

入門編はこちらをご覧ください:Vercel入門

Vercelのビルドコマンド

Vercelは、フレームワークに基づいてBuild Commandを自動的に設定します。フレームワークによって、ビルドコマンドはプロジェクトのpackage.jsonファイルを参照します。

ビルドコマンド

デフォルトのビルドコマンド

Next.jsプロジェクトの場合、Vercelは自動的に以下のビルドコマンドを使用します:

next build

カスタマイズ方法

vercel.jsonファイルをプロジェクトのルートディレクトリに配置し、ビルドコマンドをカスタマイズすることができます。

例1: next buildをビルドコマンドとして使用する場合:

{
    "buildCommand": "next build"
  }

例2:npm run custom-buildをビルドコマンドとして使用する場合:

{
    "buildCommand": "npm run custom-build"
  }

この設定により、npm run custom-buildがビルドプロセス中に実行されます。custom-buildスクリプトはpackage.json内で定義します:

{
  "scripts": {
    "custom-build": "next build && echo 'Custom build command executed!'"
  }
}

カスタムビルドコマンドの出力ログ

詳細なビルド設定の情報は、ビルドの構成をご覧ください。

vercel.jsonに関する情報は、vercel.json を使用したプロジェクトの設定をご覧ください。

環境変数の設定

設定方法

環境変数

  1. Environment Variablesセクションを選択:

    プロジェクトの設定ページに移動します。「Environment Variables」セクションを開きます。

  2. 環境(開発、プレビュー、本番)を選択:

    設定する環境を選択します。

  3. 環境変数のキーと値を入力:

    キー(名前)と値を入力します。例:API_KEYとその値。 入力後、「Save」ボタンをクリックして設定を保存します。

  4. 確認:

    環境変数が正しく設定されているか確認します。

環境変数(挿入後)

envファイルの利用

Vercelでは、.envファイルを使用して環境変数を設定することもできます。「Import .env」ボタンをクリックして、.envファイルをアップロードします。

.env.productionファイルの例:

NEXT_PUBLIC_API=http://sample.com
NEXTAUTH_SECRET=example

envファイルアップロードを利用した環境変数の設定

詳細は、環境変数をご覧ください。

Production Branchの設定

Vercelでは、Production Branch(本番ブランチ)を設定することで、本番環境へのデプロイを特定のブランチからのみ行うことができます。

設定方法

  1. Gitセクションを選択:

    プロジェクトの設定ページに移動します。「Git」セクションを開きます。

  2. Production Branchの設定:

    「Production Branch」フィールドに本番環境用のブランチ名を入力します(例:mainまたはmasterdevelopなど)。

  3. 設定の保存:

    入力後、「Save」ボタンをクリックして設定を保存します。このブランチへのプッシュが本番環境のデプロイメントをトリガーします。

Production Branchの設定

この設定により、本番環境へのデプロイが特定のブランチからのみ行われるようになります。

コードの修正とコミット

  1. コード修正前:
   export default function Page() {
     return <h1>Hello, Next.js !</h1>
   }
  1. コード修正後:
   export default function Page() {
     return <h1>Hello, Next.js Develop!</h1>
   }
  1. 修正をdevelopブランチにコミット:
   git add pages/index.js
   git commit -m "fix:pageの修正"
   git push origin develop

デプロイの確認

デプロイの確認 ※一番上がdevelopブランチへの最新コミット

この手順により、developブランチへの変更が自動的にVercelにデプロイされることを確認できます。

外崎 隼斗 (記事一覧)

アプリケーションサービス部ディベロップサービス1課

雑食系