バッチビルド仕様リファレンス - AWS CodeBuild

バッチビルド仕様リファレンス

このトピックには、バッチビルドプロパティの buildspec リファレンスが含まれています。

batch

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

batch/fast-fail

省略可能。

false

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

true

いずれかのビルドが失敗すると、実行中のすべてのビルドが停止されます。

デフォルトでは、すべてのバッチビルドタスクは、buildspec ファイルで指定されている envphases などのビルド設定を使用して実行されます。異なる env 値または異なる buildspec ファイルを batch/<batch-type>/buildspec パラメータに指定することで、デフォルトのビルド設定を上書きできます。

プロパティの内容は、指定するバッチビルドのタイプによって異なります。batchバッチビルドタイプとして以下が考えられます。

batch/build-graph

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

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

ID

必須。タスクの識別子。

buildspec

省略可能。このタスクに使用する buildspec ファイルのパスとファイル名。

依存関係

省略可能。このタスクが依存するタスク識別子の配列。このタスクは、完了するまで実行されません。

env

省略可能。ビルド環境がタスクの上書きされる。これには、次のプロパティを含めることができます。

コンピューティングタイプ

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

image

タスクに使用するイメージの識別子。指定できる値については、 の「イメージ識別子CodeBuild に用意されている Docker イメージ」を参照してください。

特権モード

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

type

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

変数

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

無視失敗

省略可能。バッチ内の失敗を無視できるかどうかを示すブール値。

false

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

true

1 つのビルドタスクが失敗した場合でも、残りのビルドタスクは引き続き実行されます。

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

batch: fast-fail: false build-graph: - identifier: build1 env: compute-type: BUILD_GENERAL1_SMALL - identifier: build2 env: compute-type: BUILD_GENERAL1_MEDIUM depend-on: - build1 - identifier: build3 env: compute-type: BUILD_GENERAL1_LARGE depend-on: - build2

詳細については、「ビルドグラフ」を参照してください。

batch/build-list

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

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

ID

必須。タスクの識別子。

buildspec

省略可能。このタスクに使用する buildspec ファイルのパスとファイル名。

依存関係

省略可能。このタスクが依存するタスク識別子の配列。このタスクは、完了するまで実行されません。

env

省略可能。ビルド環境がタスクの上書きされる。これには、次のプロパティを含めることができます。

コンピューティングタイプ

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

image

タスクに使用するイメージの識別子。指定できる値については、 の「イメージ識別子CodeBuild に用意されている Docker イメージ」を参照してください。

特権モード

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

type

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

変数

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

無視失敗

省略可能。バッチ内の失敗を無視できるかどうかを示すブール値。

false

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

true

1 つのビルドタスクが失敗した場合でも、残りのビルドタスクは引き続き実行されます。

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

batch: fast-fail: false build-list: - identifier: linux_small env: compute-type: BUILD_GENERAL1_SMALL ignore-failure: true - identifier: windows_medium env: type: WINDOWS_SERVER_2019_CONTAINER image: aws/codebuild/windows-base:2019-1.0 compute-type: BUILD_GENERAL1_MEDIUM

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

batch/build-matrix

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

静的

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

無視失敗

省略可能。バッチ内の失敗を無視できるかどうかを示すブール値。

false

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

true

1 つのビルドタスクが失敗した場合でも、残りのビルドタスクは引き続き実行されます。

env

省略可能。ビルド環境は、すべてのタスクで上書きされます。

コンピューティングタイプ

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

image

タスクに使用するイメージの識別子。指定できる値については、 の「イメージ識別子CodeBuild に用意されている Docker イメージ」を参照してください。

特権モード

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

type

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

変数

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

特権モード

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

type

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

動的

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

buildspec

省略可能。これらのタスクに使用する buildspec ファイルのパスとファイル名を含む配列。

env

省略可能。ビルド環境がタスクの上書きされる。

コンピューティングタイプ

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

image

省略可能。これらのタスクに使用するイメージの識別子を含む配列。指定できる値については、 の「イメージ識別子CodeBuild に用意されている Docker イメージ」を参照してください。

変数

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

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

batch: build-matrix: static: ignore-failure: false env: type: LINUX_CONTAINER privileged-mode: true dynamic: env: image: - aws/codebuild/amazonlinux2-x86_64-standard:3.0 - aws/codebuild/windows-base:2019-1.0 variables: MY_VAR: - VALUE1 - VALUE2 - VALUE3

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