AWS CodeBuild

パイプラインの一部としてビルドとテストを実行できます。を走らせた時 CodeBuild ビルドまたはテストアクション、ビルド仕様で指定されたコマンドは CodeBuild コンテナ。への入力アーティファクトとして指定されたすべてのアーティファクト CodeBuild アクションは、コマンドを実行するコンテナ内で使用できます。 CodeBuild は、ビルドまたはテストアクションのいずれかを提供すことができます。詳細については、「AWS CodeBuild ユーザーガイド」を参照してください。

使用するバージョン CodePipeline ウィザードでビルドプロジェクトを作成する場合は、 CodeBuild ビルドプロジェクトは、ソースプロバイダが CodePipeline であることを示します。CodeBuild コンソールでビルドプロジェクトを作成する場合、指定することはできません。 CodePipeline をソースプロバイダとして使用しますが、ビルドアクションをパイプラインに追加すると、 CodeBuild console. 詳細については、[AWS CodeBuild API リファレンス] の [ProductInformation] を参照してください。

アクションタイプ

• カテゴリ: Build または Test

• 所有者: AWS

• プロバイダー: CodeBuild

• バージョン: 1

設定パラメータ

ProjectName

: 必須 はい

ProjectName は、CodeBuild のビルドプロジェクト名です。

PrimarySource

: 必須 条件付き

の値PrimarySourceパラメータは、アクションへの入力アーティファクトの名前の 1 つでなければなりません。 CodeBuild は、ビルド仕様ファイルを探し、このアーティファクトの解凍バージョンを含むディレクトリでビルド仕様コマンドを実行します。

このパラメータは、 CodeBuild アクションに複数の入力アーティファクトが指定されている場合に必要です。アクションのソースアーティファクトが 1 つだけの場合、PrimarySource アーティファクトはデフォルトでそのアーティファクトになります。

BatchEnabled

: 必須 いいえ

この BatchEnabled パラメータのブール値は、アクションが同じビルド実行で複数のビルドを実行することを可能にします。

このオプションを有効にすると、CombineArtifacts オプションが使用できます。

バッチビルドを有効にしたパイプラインの例については、「」を参照してください。とのCodePipeline CodeBuild およびバッチビルド。

CombineArtifacts

: 必須 いいえ

この CombineArtifacts パラメータのブール値は、バッチ ビルドからのすべてのビルド アーティファクトをビルド アクションのための単一の アーティファクト ファイルにまとめます。

このオプションを使用するには、BatchEnabled パラメータを有効にする必要があります。

EnvironmentVariables

: 必須 いいえ

このパラメータの値は、パイプラインの CodeBuild アクションの環境変数を設定するために使用されます。EnvironmentVariables パラメータの値は、環境変数オブジェクトの JSON 配列の形式をとります。「アクション宣言（CodeBuild の例）」のパラメータ例を参照してください。

各オブジェクトには 3 つの部分があり、それらはすべて文字列です。

• name: 環境変数の名前またはキー。

• value: 環境変数の値。PARAMETER_STORE または SECRETS_MANAGER タイプを使用する場合、この値はそれぞれ AWS Systems Manager Parameter Store に保存済みのパラメータ名か、AWS Secrets Manager に保存済みのシークレット名である必要があります。

  注記

  特に AWS シークレット キー ID とシークレットアクセスキーなど、機密性の高い値を保存する場合は、環境変数を使用しないことを強くお勧めします。使用するバージョン CodeBuild コンソールまたはAWSCLI では、環境変数はプレーンテキストで表示されます。機密の値の場合は、代わりに SECRETS_MANAGER タイプを使用することをお勧めします。

• type: (任意) 環境変数の型。有効な値は PARAMETER_STORE、SECRETS_MANAGER、または PLAINTEXT です。指定しない場合、この値はデフォルトで PLAINTEXT になります。

注記

入るとname,value, およびtype環境変数の設定、特に環境変数に次のものが含まれている場合 CodePipeline 出力変数の構文。設定の値フィールドの 1000 文字制限を超えないようにしてください。この制限を超えると、検証エラーが返されます。

詳細については、「EnvironmentVariable」を参照してください。

入力アーティファクト

• アーティファクトの数: 1 to 5

• 説明: CodeBuild はビルド仕様ファイルを探し、プライマリソースアーティファクトのディレクトリからビルド仕様コマンドを実行します。に、複数の入力ソースが指定されている場合 CodeBuild アクションの場合、このアーティファクトはPrimarySourceCodePipeline のアクション設定パラメーター。

  各入力アーティファクトは独自のディレクトリに抽出され、その場所は環境変数に保存されます。プライマリソースアーティファクトのディレクトリは $CODEBUILD_SRC_DIR で使用できるようになります。他のすべての入力アーティファクトのディレクトリは、$CODEBUILD_SRC_DIR_yourInputArtifactName で使用できるようになります。

  注記

  で構成されたアーティファクト CodeBuild project は、 CodeBuild パイプラインでのアクション。

出力アーティファクト

• アーティファクトの数: 0 to 5

• 説明: これらは、で定義されたアーティファクトを作成するために使用できます。 CodeBuild パイプラインの後続のアクションで使用できるビルド仕様ファイル。出力アーティファクトが 1 つだけ定義されている場合、このアーティファクトはビルド仕様ファイルの artifacts セクションの直下で定義できます。複数の出力アーティファクトを指定する場合、参照されるすべてのアーティファクトは、ビルド仕様ファイルでセカンダリアーティファクトとして定義する必要があります。の出力アーティファクトの名前 CodePipeline は、ビルド仕様ファイルのアーティファクト識別子と一致する必要があります。

  注記

  で構成されたアーティファクト CodeBuild プロジェクトは CodePipeline パイプラインアクションでアーティファクトを入力します。

  バッチビルド用に CombineArtifacts パラメータが選択されている場合、出力アーティファクトの場所には、同じ実行で実行された複数のビルドから結合されたアーティファクトが含まれます。

出力変数

このアクションは、ビルドの一部としてエクスポートされたすべての環境変数を変数として生成します。環境変数のエクスポート方法の詳細については、https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#exported-variables-build-spec を参照してください。

CodePipeline における変数の詳細については、CodeBuild アクションの出力変数 を参照してください。

アクション宣言（CodeBuild の例）

YAML

Name: Build
Actions:
  - Name: PackageExport
    ActionTypeId:
      Category: Build
      Owner: AWS
      Provider: CodeBuild
      Version: '1'
    RunOrder: 1
    Configuration:
      BatchEnabled: 'true'
      CombineArtifacts: 'true'
      ProjectName: my-build-project
      PrimarySource: MyApplicationSource1
      EnvironmentVariables: '[{"name":"TEST_VARIABLE","value":"TEST_VALUE","type":"PLAINTEXT"},{"name":"ParamStoreTest","value":"PARAMETER_NAME","type":"PARAMETER_STORE"}]'
    OutputArtifacts:
      - Name: MyPipeline-BuildArtifact
    InputArtifacts:
      - Name: MyApplicationSource1
      - Name: MyApplicationSource2
      

JSON

{
    "Name": "Build",
    "Actions": [
        {
            "Name": "PackageExport",
            "ActionTypeId": {
                "Category": "Build",
                "Owner": "AWS",
                "Provider": "CodeBuild",
                "Version": "1"
            },
            "RunOrder": 1,
            "Configuration": {
                "BatchEnabled": "true",
                "CombineArtifacts": "true",
                "ProjectName": "my-build-project",
                "PrimarySource": "MyApplicationSource1",
                "EnvironmentVariables": "[{\"name\":\"TEST_VARIABLE\",\"value\":\"TEST_VALUE\",\"type\":\"PLAINTEXT\"},{\"name\":\"ParamStoreTest\",\"value\":\"PARAMETER_NAME\",\"type\":\"PARAMETER_STORE\"}]"
            },
            "OutputArtifacts": [
                {
                    "Name": "MyPipeline-BuildArtifact"
                }
            ],
            "InputArtifacts": [
                {
                    "Name": "MyApplicationSource1"
                },
                {
                    "Name": "MyApplicationSource2"
                }
            ]
        }
    ]
}

以下の資料も参照してください。

このアクションを利用する際に役立つ関連リソースは以下の通りです。

• AWS CodeBuildユーザーガイド— パイプラインの例 CodeBuild アクション、「」を参照してください。を使用する CodePipeline と CodeBuild コードをテストし、ビルドを実行するには。複数の入力と出力を持つプロジェクトの例 CodeBuild アーティファクト、とのCodePipeline CodeBuild および複数の入力ソースおよび出力アーティファクトのサンプルそして複数の入力ソースと出力アーティファクトサンプル。

• チュートリアル: を使用して Android アプリをビルドしてテストするパイプラインを作成します。AWS Device Farmこのチュートリアルでは、でパイプラインを作成するためのビルド仕様ファイルとサンプルアプリケーションを提供します。 GitHub を使用して Android アプリを構築し、テストするソース CodeBuild そしてAWS Device Farm。

• のビルド仕様に関するリファレンス CodeBuild このリファレンストピックでは、理解するための定義と例を示します。 CodeBuild スペックファイルをビルドします。