Code Build

How it works

• CodeBuild work on Build Projects
• Build Project has
  • location to get source code
  • build environment - OS, runtime, tools, etc.
  • build specification
    • commands to run
    • output to upload to S3
    • notification to send

Planning

• Source - CodeCommit, S3, GitHub, Bitbucket
• Commands
• Run time & tools - docker images from
  • AWS CodeBuild Docker image repository
  • Docker Hub,
  • Amazon Elastic Container Registry (Amazon ECR)
• What extra privilege the SERVICE needs? (modify service role)
• VPC considerations

Build Environment

Docker image

• AWS registry (AWS optimized) https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html
• Public Docker registry images (docker search...)
• ECR - AWS registry for user images

Computer type

Default environment variables

https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html

$CODEBUILD_SRC_DIR

Background tasks

Use "nohup" & "disown", see https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-background-tasks.html

Local testing

https://docs.aws.amazon.com/codebuild/latest/userguide/use-codebuild-agent.html

https://hub.docker.com/r/amazon/aws-codebuild-local/

Just download the command line script and run with an image and an output folder. If want to use Amazon curated image, download from link below and build the image locally.

https://github.com/aws/aws-codebuild-docker-images

Build Specification

https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html

• where
  • with source file (default /buildspec.yml, can be set by project) or
  • with build project
• format: YAML

version: 0.2

run-as: Linux-user-name

env:

  variables:

    key: "value"

    key: "value"

  parameter-store:

    key: "value"

    key: "value"

phases:

  install:

    run-as: Linux-user-name

    commands:

      - command

      - command

    finally:

      - command

      - command

  pre_build:

    run-as: Linux-user-name

    commands:

      - command

      - command

    finally:

      - command

      - command

  build:

    run-as: Linux-user-name

    commands:

      - command

      - command

    finally:

      - command

      - command

  post_build:

    run-as: Linux-user-name

    commands:

      - command

      - command

    finally:

      - command

      - command

artifacts:

  files:

    - location

    - location

    - name

  discard-paths: yes

  base-directory: location

  secondary-artifacts:

    artifactIdentifier:

      files:

        - location

        - location

      discard-paths: yes

      base-directory: location

    artifactIdentifier:

      files:

        - location

        - location

      discard-paths: yes

      base-directory: location

cache:

  paths:

    - path

    - path

version: "0.2" recommended, version of the spec format

run-as: optional, by default root, linux only, can also be provided in a phrase block

env: optional

variables: required in env, environment variables, not recommended for secrets

parameter-store: Amazon EC2 Systems Manager Parameter Store values, secret ok

phases:

[name]: allowed phases include:

• install - optional, for installation of tools & packages in test environment
• pre-build - optional, for example signin something or npm install
• build - optional
• post-build - optional, for example packaging, push to registry, send notifications, etc

run-as: optional, default root or the build spec global run-as

commands: commands to run

finally: optional, commands to run even (no matter) any command in "commands" fail

artifacts: optional (not required if product is pushed to registry or just running tests)

files: required, paths

discard-paths: optional

base-directory: optional, alternative base-dir

secondary-artifacts: optional, more artifacts to different destinations

name: optional, can be like "myname-$(date +%Y-%m-%d)"

cache: optional

Ignored Topics

VPC

Jenkins integration

Monitoring

Triggers - timers for build