バッチビルドのビルド仕様 (buildspec) のリファレンス

このトピックでは、バッチビルドプロパティの ビルド仕様 (buildspec) リファレンスを示します。

batch

オプションのマッピング。プロジェクトのバッチビルド設定。

batch/fast-fail

オプション。1 つ以上のビルドタスクが失敗した場合のバッチビルドの動作を指定します。

false

デフォルト値。実行中のすべてのビルドが完了します。

true

ビルドタスクの 1 つが失敗すると、実行中のすべてのビルドが停止します。

デフォルトでは、ビルド仕様 (buildspec) ファイルで指定された、すべてのバッチビルドタスクは、envおよびphases を実行します。デフォルトのビルド設定をオーバーライドするには、「env」値または別の buildspec ファイルを「batch/<batch-type>/buildspec」パラメータで指定します。

「batch」プロパティの内容は、指定されたバッチビルドのタイプによって異なります。可能なバッチビルドタイプは次のとおりです。

• batch/build-graph

• batch/build-list

• batch/build-matrix

batch/build-graph

ビルドグラフを定義。ビルドグラフは、バッチ内の他のタスクに依存する一連のタスクを定義します。詳細については、「ビルドグラフ」を参照してください。

この要素には、ビルドタスクの配列が含まれます。各ビルドタスクには、以下のプロパティが含まれます。

ID

必須。タスクの識別子。

buildspec

オプション。このタスクに使用する buildspec ファイルのパスとファイル名。このパラメータを指定しないと、現在の buildspec ファイルが使用されます。

debug-session

オプション。セッションデバッグがこのバッチビルドで有効かどうかを示す、ブール値。セッションデバッグの詳細については、「セッションマネージャーで実行中のビルドを表示する」を参照してください。

false

セッションデバッグは無効です。

true

セッションデバッグは有効です。

依存

オプション。このタスクが依存するタスク識別子の配列。このタスクは、これらのタスクが完了するまで実行されません。

env

オプション。タスクのビルド環境がオーバーライドされます。次のプロパティが含まれています。

compute-type

タスクに使用するコンピューティングタイプの識別子。可能な値については、ビルド環境のコンピューティングモードおよびタイプ の「computeType」を参照してください。

イメージ

タスクに使用するイメージの識別子。可能な値については、が提供する Docker イメージ CodeBuild の「イメージ識別子」を参照してください。

privileged-mode

Docker コンテナ内の Docker デーモンを実行するかどうかを示すブール値。ビルドプロジェクトを使用して Docker イメージを構築する場合にのみ、true に設定します。そうしないと、Docker デーモンとやり取りしようとするビルドは失敗します。デフォルトの設定は、false です。

type

タスクに使用する環境タイプの識別子です。可能な値については、ビルド環境のコンピューティングモードおよびタイプ の「環境タイプ」を参照してください。

variables

ビルド環境に存在する環境変数。詳細については、「env/variables」を参照してください。

ignore-failure

オプション。このビルドタスクの失敗を無視できるかどうかを示すブール値。

false

デフォルト値。このビルドタスクが失敗すると、バッチビルドが失敗します。

true

このビルドタスクが失敗した場合でも、バッチビルドが成功します。

ビルドグラフの buildspec エントリの例を次に示します。

batch:
  fast-fail: false
  build-graph:
    - identifier: build1
      env:
        variables:
          BUILD_ID: build1
      ignore-failure: false
    - identifier: build2
      buildspec: build2.yml
      env:
        variables:
          BUILD_ID: build2
      depend-on:
        - build1
    - identifier: build3
      env:
        variables:
          BUILD_ID: build3
      depend-on:
        - build2

batch/build-list

ビルドリストを定義。ビルドリストは、並行して実行されるタスクの数を定義するために使用されます。詳細については、「ビルドリスト」を参照してください。

この要素には、ビルドタスクの配列が含まれます。各ビルドタスクには、以下のプロパティが含まれます。

ID

必須。タスクの識別子。

buildspec

オプション。このタスクに使用する buildspec ファイルのパスとファイル名。このパラメータを指定しないと、現在の buildspec ファイルが使用されます。

debug-session

オプション。セッションデバッグがこのバッチビルドで有効かどうかを示す、ブール値。セッションデバッグの詳細については、「セッションマネージャーで実行中のビルドを表示する」を参照してください。

false

セッションデバッグは無効です。

true

セッションデバッグは有効です。

env

オプション。タスクのビルド環境がオーバーライドされます。次のプロパティが含まれています。

compute-type

タスクに使用するコンピューティングタイプの識別子。可能な値については、ビルド環境のコンピューティングモードおよびタイプ の「computeType」を参照してください。

イメージ

タスクに使用するイメージの識別子。可能な値については、が提供する Docker イメージ CodeBuild の「イメージ識別子」を参照してください。

privileged-mode

Docker コンテナ内の Docker デーモンを実行するかどうかを示すブール値。ビルドプロジェクトを使用して Docker イメージを構築する場合にのみ、true に設定します。そうしないと、Docker デーモンとやり取りしようとするビルドは失敗します。デフォルトの設定は、false です。

type

タスクに使用する環境タイプの識別子です。可能な値については、ビルド環境のコンピューティングモードおよびタイプ の「環境タイプ」を参照してください。

variables

ビルド環境に存在する環境変数。詳細については、「env/variables」を参照してください。

ignore-failure

オプション。このビルドタスクの失敗を無視できるかどうかを示すブール値。

false

デフォルト値。このビルドタスクが失敗すると、バッチビルドが失敗します。

true

このビルドタスクが失敗しても、バッチビルドは成功します。

buildspec エントリの例を次に示します。

batch:
  fast-fail: false
  build-list:
    - identifier: build1
      env:
        variables:
          BUILD_ID: build1
      ignore-failure: false
    - identifier: build2
      buildspec: build2.yml
      env:
        variables:
          BUILD_ID: build2
      ignore-failure: true

batch/build-matrix

ビルドマトリックスを定義する。ビルドマトリックスは、並行して実行される異なる構成のタスクを定義します。CodeBuild は、設定可能な組み合わせごとに個別のビルドを作成します。詳細については、「ビルドマトリックス」を参照してください。

static

静的プロパティは、すべてのビルドタスクに適用されます。

ignore-failure

オプション。このビルドタスクの失敗を無視できるかどうかを示すブール値。

false

デフォルト値。このビルドタスクが失敗すると、バッチビルドが失敗します。

true

このビルドタスクが失敗しても、バッチビルドは成功します。

env

オプション。ビルド環境はすべてのタスクに対して上書きされます。

privileged-mode

Docker コンテナ内の Docker デーモンを実行するかどうかを示すブール値。ビルドプロジェクトを使用して Docker イメージを構築する場合にのみ、true に設定します。そうしないと、Docker デーモンとやり取りしようとするビルドは失敗します。デフォルトの設定は、false です。

type

タスクに使用する環境タイプの識別子です。可能な値については、ビルド環境のコンピューティングモードおよびタイプ の「環境タイプ」を参照してください。

dynamic

動的プロパティはビルドマトリックスを定義します。

buildspec

オプション。これらのタスクに使用する buildspec ファイルのパスとファイル名を含む配列。このパラメータを指定しないと、現在の buildspec ファイルが使用されます。

env

オプション。これらのタスクでは、ビルド環境が上書きされます。

compute-type

これらのタスクに使用するコンピューティングタイプの識別子を含む配列。可能な値については、ビルド環境のコンピューティングモードおよびタイプ の「computeType」を参照してください。

イメージ

これらのタスクに使用するイメージの識別子を含む配列。可能な値については、が提供する Docker イメージ CodeBuild の「イメージ識別子」を参照してください。

変数

これらのタスクのビルド環境に存在する環境変数を含む配列。詳細については、「env/variables」を参照してください。

ビルドマトリックス「buildspec」のエントリの例を次に示します。

batch:
  build-matrix:
    static:
      ignore-failure: false
    dynamic:
      buildspec: 
        - matrix1.yml
        - matrix2.yml
      env:
        variables:
          MY_VAR:
            - VALUE1
            - VALUE2
            - VALUE3

詳細については、「ビルドマトリックス」を参照してください。