Amazon CodePipeline integration with CodeBuild and multiple input sources and output artifacts sample - Amazon CodeBuild
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Amazon CodePipeline integration with CodeBuild and multiple input sources and output artifacts sample

An Amazon CodeBuild project can take more than one input source. It can also create more than one output artifact. This sample demonstrates how to use Amazon CodePipeline to create a build project that uses multiple input sources to create multiple output artifacts. For more information, see Multiple input sources and output artifacts sample.

You can use a JSON-formatted file that defines the structure of your pipeline, and then use it with the Amazon CLI to create the pipeline. Use the following JSON file as an example of a pipeline structure that creates a build with more than one input source and more than one output artifact. Later in this sample you see how this file specifies the multiple inputs and outputs. For more information, see CodePipeline pipeline structure reference in the Amazon CodePipeline User Guide.

{
 "pipeline": {
  "roleArn": "arn:aws:iam::account-id:role/my-AWS-CodePipeline-service-role-name",
  "stages": [
    {
      "name": "Source",
      "actions": [
        {
          "inputArtifacts": [],
          "name": "Source1",
          "actionTypeId": {
            "category": "Source",
            "owner": "AWS",
            "version": "1",
            "provider": "S3"
          },
          "outputArtifacts": [
            {
              "name": "source1"
            }
          ],
          "configuration": {
            "S3Bucket": "my-input-bucket-name",
            "S3ObjectKey": "my-source-code-file-name.zip"
          },
          "runOrder": 1
        },
        {
          "inputArtifacts": [],
          "name": "Source2",
          "actionTypeId": {
            "category": "Source",
            "owner": "AWS",
            "version": "1",
            "provider": "S3"
          },
          "outputArtifacts": [
            {
              "name": "source2"
            }
          ],
          "configuration": {
            "S3Bucket": "my-other-input-bucket-name",
            "S3ObjectKey": "my-other-source-code-file-name.zip"
          },
          "runOrder": 1
        }
      ]
    },
    {
      "name": "Build",
      "actions": [
        {
          "inputArtifacts": [
            {
              "name": "source1"
            },
            {
              "name": "source2"
            }
          ],
          "name": "Build",
          "actionTypeId": {
            "category": "Build",
            "owner": "AWS",
            "version": "1",
            "provider": "AWS CodeBuild"
          },
          "outputArtifacts": [
            {
              "name": "artifact1"
            },
            {
              "name": "artifact2"
            }
          ],
          "configuration": {
            "ProjectName": "my-build-project-name",
            "PrimarySource": "source1"
          },
          "runOrder": 1
        }
      ]
    }
  ],
  "artifactStore": {
    "type": "S3",
    "location": "AWS-CodePipeline-internal-bucket-name"
  },
  "name": "my-pipeline-name",
  "version": 1
 }
}

In this JSON file:

  • One of your input sources must be designated the PrimarySource. This source is the directory where CodeBuild looks for and runs your buildspec file. The keyword PrimarySource is used to specify the primary source in the configuration section of the CodeBuild stage in the JSON file.

  • Each input source is installed in its own directory. This directory is stored in the built-in environment variable $CODEBUILD_SRC_DIR for the primary source and $CODEBUILD_SRC_DIR_yourInputArtifactName for all other sources. For the pipeline in this sample, the two input source directories are $CODEBUILD_SRC_DIR and $CODEBUILD_SRC_DIR_source2. For more information, see Environment variables in build environments.

  • The names of the output artifacts specified in the pipeline's JSON file must match the names of the secondary artifacts defined in your buildspec file. This pipeline uses the following buildspec file. For more information, see Buildspec syntax. 

    version: 0.2

phases:
  build:
    commands:
      - touch source1_file
      - cd $CODEBUILD_SRC_DIR_source2
      - touch source2_file

artifacts:
  files:
    - '**/*'
  secondary-artifacts:
    artifact1:
      base-directory: $CODEBUILD_SRC_DIR
      files:
        - source1_file
    artifact2:
      base-directory: $CODEBUILD_SRC_DIR_source2
      files:
        - source2_file

After you create the JSON file, you can create your pipeline. Use the Amazon CLI to run the create-pipeline command and pass the file to the --cli-input-json parameter. For more information, see Create a pipeline (CLI) in the Amazon CodePipeline User Guide.