ビルド仕様のコマンドと設定ブランチ固有のビルド設定サブフォルダに移動するフロントエンドでバックエンドをデプロイする出力フォルダの設定ビルドの一部としてパッケージをインストールするプライベート npm レジストリを使用する OS パッケージのインストールビルドごとのキーと値のストレージコミットのビルドをスキップする自動ビルドを無効にする差分ベースのフロントエンドビルドとデプロイを有効または無効にする差分ベースのバックエンドビルドを有効または無効にする

ビルド設定の構成

Amplify ホスティングを使用してアプリをデプロイすると、リポジトリ内の package.json ファイルを検査することで、フロントエンドフレームワークと関連するビルド設定が自動的に検出されます。アプリのビルド設定を保存するには、次のオプションがあります。

Amplify コンソールでビルド設定を保存する - Amplify コンソールを使用してビルド設定を自動検出および保存することで、Amplify コンソールからアクセスできるようになります。リポジトリに amplify.yml ファイルが保存されている場合を除き、Amplify はこれらの設定をすべてのブランチに適用します。
ビルド設定をリポジトリに保存する - amplify.yml ファイルをダウンロードして、リポジトリのルートに追加します。

Amplify コンソールでアプリのビルド設定を編集するには、[アプリの設定]、[ビルドの設定]の順に選択します。ビルド設定は、アプリ内のすべてのブランチに適用されます。ただし、リポジトリに amplify.yml ファイルが保存されたブランチを除きます。

注記

「ビルド設定」は、アプリが継続的デプロイ用に設定され、git リポジトリに接続されている場合にのみ、Amplify コンソールの「アプリ設定」メニューに表示されます。この種類のデプロイの手順については、「既存のコードを使い始める」を参照してください。

ビルド仕様のコマンドと設定

YAML ビルド仕様には、Amplify でビルドの実行に使用される一連のビルドコマンドと関連設定が含まれます。以下のリストでは、これらの設定とその使用方法について説明しています。

version

Amplify YAML バージョン番号。

appRoot

このアプリケーションが置かれているリポジトリ内のパス。複数のアプリケーションが定義されていない限り無視されます。

env

環境変数をこのセクションに追加します。また、環境変数はコンソールを使用して追加することもできます。

backend

Amplify CLI コマンドを実行して、バックエンドのプロビジョン、Lambda 関数の更新、または継続的なデプロイの一環としての GraphQL スキーマの更新を行います。フロントエンドでバックエンドをデプロイする方法について説明します。

frontend

フロントエンドのビルドコマンドを実行します。

test

テストフェーズ中にコマンドを実行します。アプリにテストを追加する方法をご覧ください。

ビルドフェーズ

フロントエンド、バックエンド、およびテストには、ビルドの各シーケンス中に実行されるコマンドを表す 3 つの「フェーズ」があります。

preBuild - preBuild スクリプトが、実際のビルドの開始前、Amplify が依存関係をインストールした後に実行されます。
build - お客様のビルドコマンド。
postBuild - post-build スクリプトは、ビルドが終了し、Amplify が必要なすべてのアーティファクトを出力ディレクトリにコピーした後に実行されます。

buildpath

ビルドの実行に使用するパス。Amplify はこのパスを使用してビルドアーティファクトを見つけます。パスを指定しない場合、Amplify は、モノレポのアプリルートを使用します。(例: apps/app)

artifacts>base-directory

ビルドアーティファクトが存在するディレクトリ。

artifacts>files

デプロイするアーティファクトからファイルを指定します。すべてのファイルを含めるには **/* を入力します。

cache

buildspec の cache フィールドは、node_modules フォルダーなどのビルド時の依存関係をキャッシュするために使用され、顧客のアプリに組み込まれているパッケージマネージャーとフレームワークに基づいて自動的に提案されます。最初のビルドでは、ここにあるすべてのパスがキャッシュされ、その後のビルドではキャッシュを再度増やし、ビルド時間を短縮するためにキャッシュされた依存関係を可能な限り使用します。

以下のビルド仕様例は、基本的な YAML 構文を示しています。


version: 1
env:
  variables:
    key: value
backend:
  phases:
    preBuild:
      commands:
        - *enter command*
    build:
      commands:
        - *enter command*
    postBuild:
        commands:
        - *enter command*
frontend:
  buildpath:
  phases:
    preBuild:
      commands:
        - cd react-app
        - npm ci
    build:
      commands:
        - npm run build
  artifacts:
    files:
        - location
        - location
    discard-paths: yes
    baseDirectory: location
  cache:
    paths:
        - path
        - path
test:
  phases:
    preTest:
      commands:
        - *enter command*
    test:
      commands:
        - *enter command*
    postTest:
      commands:
        - *enter command*
  artifacts:
    files:
        - location
        - location
    configFilePath: *location*
    baseDirectory: *location*

ブランチ固有のビルド設定

bash シェルスクリプトを使用してブランチ固有のビルドを設定できます。たとえば、次のスクリプトは、システム環境変数 $AWS_BRANCH を使用して、ブランチ名がmain の場合はあるコマンドセットを実行し、ブランチ名が dev の場合は別のコマンドセットを実行します。


frontend:
  phases:
    build:
      commands:
        - if [ "${AWS_BRANCH}" = "main" ]; then echo "main branch"; fi
        - if [ "${AWS_BRANCH}" = "dev" ]; then echo "dev branch"; fi

サブフォルダに移動する

モノレポの場合、ユーザーは、cd を実行してフォルダに移動して、ビルドを実行できる必要があります。cd コマンドを実行すると、コマンドがビルドのすべてのステージに適用されるため、各フェーズでコマンドを再度実行する必要はありません。


version: 1
env:
  variables:
    key: value
frontend:
  phases:
    preBuild:
      commands:
        - cd react-app
        - npm ci
    build:
      commands:
        - npm run build

フロントエンドでバックエンドをデプロイする

amplifyPush コマンドは、バックエンドのデプロイを支援するヘルパースクリプトです。以下のビルド設定によって、現在のブランチにデプロイする上で適切なバックエンド環境が自動的に判別されます。


version: 1
env:
  variables:
    key: value
backend:
  phases:
    build:
      commands:
        - amplifyPush --simple

出力フォルダの設定

次のビルド設定は、出力ディレクトリをパブリックフォルダに設定します。


frontend:
  phases:
    commands:
      build:
        - yarn run build
  artifacts:
    baseDirectory: public

ビルドの一部としてパッケージをインストールする

npm または yarn コマンドを使って、ビルド中にパッケージをインストールすることができます。


frontend:
  phases:
    build:
      commands:
        - npm install -g <package>
        - <package> deploy
        - yarn run build
  artifacts:
    baseDirectory: public

プライベート npm レジストリを使用する

プライベートレジストリへのリファレンスは、ビルド設定で追加するか、環境変数として追加することができます。


build:
  phases:
    preBuild:
      commands:
        - npm config set <key> <value>
        - npm config set registry https://registry.npmjs.org
        - npm config set always-auth true
        - npm config set email hello@amplifyapp.com
        - yarn install

OS パッケージのインストール

AmplifyのAL2023イメージは、という名前の非特権ユーザーでコードを実行します。amplifyAmplify は、sudo Linuxコマンドを使用してOSコマンドを実行する権限をこのユーザーに付与します。依存関係がないために OS パッケージをインストールしたい場合は、yumrpmやなどのコマンドを使用できます。sudo

以下のビルドセクション例は、sudoコマンドを使用して OS パッケージをインストールする構文を示しています。


build:
  phases:
    preBuild:
      commands:
        - sudo yum install -y <package>

ビルドごとのキーと値のストレージ

envCache はビルド時に key-value ストレージを提供します。envCache に保存された値はビルド中にのみ変更でき、次回のビルドで再利用できます。envCache を使用することで、デプロイされた環境に情報を保存し、それを連続したビルドでビルドコンテナを利用できるようにします。envCache に保存された値とは異なり、ビルド中に環境変数を変更しても、将来のビルドには反映されません。

使用例:


envCache --set <key> <value>
envCache --get <key>

コミットのビルドをスキップする

特定のコミットの自動ビルドをスキップするには、コミットメッセージの末尾に [skip-cd] というテキストを含めます。

自動ビルドを無効にする

コードのコミットごとに自動ビルドを無効にするように Amplify を設定できます。セットアップするには、[アプリの設定]、[全般]の順に選択し、接続されたすべてのブランチがある「ブランチ」セクションまでスクロールします。ブランチを選択してから、[アクション]、[自動構築を無効化]を選択します。さらにそのブランチにコミットしても、新しいビルドは作成されません。

差分ベースのフロントエンドビルドとデプロイを有効または無効にする

差分ベースのフロントエンドビルドを使用するように Amplify を設定できます。有効にすると、Amplify は各ビルドの開始時に、デフォルトで自分の appRoot フォルダー、または /src/ フォルダーの差分を実行しようとします。Amplify で差分が見つからなかった場合、フロントエンドのビルド、テスト (設定されている場合)、およびデプロイのステップはスキップされ、ホストされているアプリは更新されません。

差分ベースのフロントエンドビルドとデプロイを設定するには

AWS Management Console にサインインし、Amplify コンソールを開きます。
アプリを選択して、差分ベースのフロントエンドビルドとデプロイを設定します。
ナビゲーションペインで、[アプリ設定]、[環境変数] を選択します。
「環境変数」セクションで、[変数の管理] を選択します。
環境変数を設定する手順は、差分ベースのフロントエンドビルドとデプロイを有効にするか無効にするかによって異なります。
- 差分ベースのフロントエンドビルドとデプロイを有効化するには
  1. 「変数の管理」セクションの [変数] に、AMPLIFY_DIFF_DEPLOY と入力します。
  2. [値] に「true」と入力します。
- 差分ベースのフロントエンドビルドとデプロイを無効化するには
  1. 次のいずれかを行います。
    - 「変数の管理」セクションで、AMPLIFY_DIFF_DEPLOY を探します。[値] に「false」と入力します。
    - AMPLIFY_DIFF_DEPLOY 環境変数を削除します。
[保存] を選択します。

オプションで、デフォルトパスをリポジトリのルートからの相対パス (distなど) でオーバーライドするように環境変数 AMPLIFY_DIFF_DEPLOY_ROOT を設定できます。

差分ベースのバックエンドビルドを有効または無効にする

環境変数 AMPLIFY_DIFF_BACKEND を使用して、差分ベースのバックエンドビルドを使用するように Amplify ホスティングを設定できます。差分ベースのバックエンドビルドを有効にすると、各ビルドの開始時に、Amplify はリポジトリ内の amplify フォルダーで差分を実行しようとします。Amplify が差分を見つけられない場合、バックエンドのビルドステップをスキップし、バックエンドリソースを更新しません。プロジェクトのリポジトリに amplify フォルダがない場合、Amplify は環境変数 AMPLIFY_DIFF_BACKEND の値を無視します。

現在、バックエンドフェーズのビルド設定でカスタムコマンドが指定されている場合、条件付きバックエンドビルドは機能しません。これらのカスタムコマンドを実行したい場合は、アプリの amplify.yml ファイルにあるビルド設定のフロントエンドフェーズに移動する必要があります。

差分ベースのバックエンドビルドを設定するには

AWS Management Console にサインインし、Amplify コンソールを開きます。
差分ベースのバックエンドビルドを設定するアプリを選択します。
ナビゲーションペインで、[アプリ設定]、[環境変数] を選択します。
「環境変数」セクションで、[変数の管理] を選択します。
環境変数を設定する手順は、差分ベースのバックエンドビルドを有効化／無効化するかによって異なります。
- 差分ベースのバックエンドビルドを有効にするには
  1. 「変数の管理」セクションの [変数] に、AMPLIFY_DIFF_BACKEND と入力します。
  2. [値] に「true」と入力します。
- 差分ベースのバックエンドビルドを無効にするには
  1. 次のいずれかを行います。
    - 「変数の管理」セクションで、AMPLIFY_DIFF_BACKEND を探します。[値] に「false」と入力します。
    - AMPLIFY_DIFF_BACKEND 環境変数を削除します。
[保存] を選択します。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

カスタムドメインのトラブルシューティング

モノレポのビルド設定