AWS CodeBuild
User Guide (API Version 2016-10-06)

Plan a Build for AWS CodeBuild

Before you run your build with CodeBuild, you must answer these questions:

  1. Where is the source code located? CodeBuild currently supports building from the following source code repository providers. The source code must contain a build specification (build spec) file, or the build spec must be declared as part of a build project definition. A build spec is a collection of build commands and related settings, in YAML format, that CodeBuild uses to run a build.

    Repository provider Required Documentation
    CodeCommit

    Repository name.

    (Optional) Commit ID associated with the source code.

    See these topics in the CodeCommit User Guide:

    Create a CodeCommit Repository

    Create a Commit in CodeCommit

    Amazon S3

    Input bucket name.

    Object name corresponding to the build input ZIP file that contains the source code.

    (Optional) Version ID associated with the build input ZIP file.

    See these topics in the Amazon S3 Getting Started Guide:

    Create a Bucket

    Add an Object to a Bucket

    GitHub

    Repository name.

    (Optional) Commit ID associated with the source code.

    See this topic on the GitHub Help website:

    Create a Repo

    Bitbucket

    Repository name.

    (Optional) Commit ID associated with the source code.

    See this topic on the Bitbucket Cloud documentation website:

    Create a repository

  2. Which build commands do you need to run and in what order? By default, CodeBuild downloads the build input from the provider you specify and uploads the build output to the bucket you specify. You use the build spec to instruct how to turn the downloaded build input into the expected build output. For more information, see the Build Spec Reference.

  3. Which runtimes and tools do you need to run the build? For example, are you building for Java, Ruby, Python, or Node.js? Does the build need Maven or Ant or a compiler for Java, Ruby, or Python? Does the build need Git, the AWS CLI, or other tools?

    CodeBuild runs builds in build environments that use Docker images. These Docker images must be stored in a repository type supported by CodeBuild. These include the CodeBuild Docker image repository, Docker Hub, and Amazon Elastic Container Registry (Amazon ECR). For more information about the CodeBuild Docker image repository, see Docker Images Provided by CodeBuild.

    Important

    If you use the Ubuntu standard image 2.0 or later, or the Amazon Linux 2 (AL2) standard image 1.0 or later, you must specify runtime-versions in your buildspec file. For more information, see Specify Runtime Versions in the Buildspec File.

  4. Do you need AWS resources that aren't provided automatically by CodeBuild? If so, which security policies will those resources need? For example, you might need to modify the CodeBuild service role to allow CodeBuild to work with those resources.

  5. Do you want CodeBuild to work with your VPC? If so, you need the VPC ID, the subnet IDs, and security group IDs for your VPC configuration. For more information, see Use CodeBuild with Amazon Virtual Private Cloud.

After you have answered these questions, you should have the settings and resources you need to run a build successfully. To run your build, you can:

  • Use the CodeBuild console, AWS CLI, or AWS SDKs. For more information, see Run AWS CodeBuild Directly.

  • Create or identify a pipeline in AWS CodePipeline, and then add a build or test action that instructs CodeBuild to automatically test your code, run your build, or both. For more information, see Use AWS CodePipeline with CodeBuild.