CodeBuild 빌드 사양 참조 - AWS CodeBuild

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

CodeBuild 빌드 사양 참조

이 주제에서는 빌드 사양(buildspec) 파일에 대한 중요한 참조 정보를 제공합니다. AbuildSpec는 CodeBuild가 빌드를 실행하는 데 사용하는 YAML 형식의 빌드 명령 및 관련 설정의 모음입니다. 소스 코드의 일부로 buildspec을 포함하거나, 빌드 프로젝트를 생성할 때 buildspec을 정의할 수 있습니다. 빌드 사양의 작동 방식에 대한 자세한 정보는 CodeBuild 작동 방식 단원을 참조하십시오.

buildspec 파일 이름 및 스토리지 위치

buildspec을 소스 코드의 일부로 포함하는 경우, 기본적으로 buildspec 파일에 buildspec.yml이라는 이름을 지정해야 하며 이 파일을 소스 디렉터리의 루트에 배치해야 합니다.

기본 buildspec 파일 이름과 위치를 재정의할 수 있습니다. 예를 들어 다음을 수행할 수 있습니다.

  • 동일한 리포지토리의 다른 빌드에 대해 buildspec_debug.ymlbuildspec_release.yml과 같은 다른 buildspec 파일을 사용합니다.

  • buildspec 파일을 config/buildspec.yml과 같은 소스 디렉터리의 루트가 아닌 다른 위치 또는 S3 버킷에 저장합니다. S3 버킷은 빌드 프로젝트와 동일한 AWS 리전에 있어야 합니다. ARN을 사용하여 buildspec 파일을 지정합니다(예: arn:aws:s3:::my-codebuild-sample2/buildspec.yml).

buildspec 파일의 이름과 상관없이, 한 빌드 프로젝트에 대해 하나의 buildspec만 지정할 수 있습니다.

기본 buildspec 파일 이름이나 위치 또는 둘 다를 재정의하려면 다음 중 하나를 수행합니다.

  • AWS CLI 실행create-project또는update-project명령을 사용하여buildspec값을 내장 환경 변수 의 값에 상대적인 대체 buildspec 파일의 경로로 설정합니다.CODEBUILD_SRC_DIR를 선택합니다. 와 동등한 작업을 수행할 수도 있습니다.create projectAWS SDK에서 작업을 수행할 수 있습니다. 자세한 내용은 빌드 프로젝트 생성 또는 빌드 프로젝트 설정 변경 단원을 참조하십시오.

  • AWS CLI 실행start-build명령을 사용하여buildspecOverride값을 내장 환경 변수 의 값에 상대적인 대체 buildspec 파일의 경로로 설정합니다.CODEBUILD_SRC_DIR를 선택합니다. 와 동등한 작업을 수행할 수도 있습니다.start buildAWS SDK에서 작업을 수행할 수 있습니다. 자세한 내용은 빌드 실행 단원을 참조하세요.

  • AWS CloudFormation 템플릿에서BuildSpec의 속성Source유형의 리소스에서AWS::CodeBuild::Project내장 환경 변수 의 값에 상대적인 대체 buildspec 파일의 경로로 설정하십시오.CODEBUILD_SRC_DIR를 선택합니다. 자세한 내용은 의 BuildSpec 속성을 참조하십시오.AWS CodeBuild 프로젝트 소스AWS CloudFormation 사용 설명서를 선택합니다.

buildspec 구문

buildspec 파일은 YAML 형식으로 표시해야 합니다.

명령에 YAML에서 지원하지 않는 문자 또는 문자열이 포함된 경우 명령을 따옴표("")로 묶어야 합니다. YAML에서는 콜론(:) 뒤에 공백이 올 수 없으므로 다음 명령을 따옴표로 묶습니다. 명령의 따옴표는 이스케이프(\")됩니다.

"export PACKAGE_NAME=$(cat package.json | grep name | head -1 | awk -F: '{ print $2 }' | sed 's/[\",]//g')"

buildspec 구문은 다음과 같습니다.

version: 0.2 run-as: Linux-user-name env: shell: shell-tag variables: key: "value" key: "value" parameter-store: key: "value" key: "value" exported-variables: - variable - variable secrets-manager: key: secret-id:json-key:version-stage:version-id git-credential-helper: no | yes proxy: upload-artifacts: no | yes logs: no | yes batch: fast-fail: false | true # build-list: # build-matrix: # build-graph: phases: install: run-as: Linux-user-name on-failure: ABORT | CONTINUE runtime-versions: runtime: version runtime: version commands: - command - command finally: - command - command pre_build: run-as: Linux-user-name on-failure: ABORT | CONTINUE commands: - command - command finally: - command - command build: run-as: Linux-user-name on-failure: ABORT | CONTINUE commands: - command - command finally: - command - command post_build: run-as: Linux-user-name on-failure: ABORT | CONTINUE commands: - command - command finally: - command - command reports: report-group-name-or-arn: files: - location - location base-directory: location discard-paths: no | yes file-format: report-format artifacts: files: - location - location name: artifact-name discard-paths: no | yes base-directory: location exclude-paths: excluded paths enable-symlinks: no | yes s3-prefix: prefix secondary-artifacts: artifactIdentifier: files: - location - location name: secondary-artifact-name discard-paths: no | yes base-directory: location artifactIdentifier: files: - location - location discard-paths: no | yes base-directory: location cache: paths: - path - path

buildspec에는 다음이 포함됩니다.

version

필수 매핑. buildspec 버전을 나타냅니다. 0.2를 사용할 것을 권장합니다.

참고

버전 0.1도 계속 지원되지만 가능하면 버전 0.2를 사용할 것을 권장합니다. 자세한 내용은 buildspec 버전 단원을 참조하세요.

run-as

선택적 시퀀스. Linux 사용자만 사용할 수 있습니다. 이 buildspec 파일에서 명령을 실행하는 Linux 사용자를 지정합니다. run-as는 지정된 사용자에게 읽기 및 실행 권한을 부여합니다. buildspec 파일 처음에 run-as를 지정할 경우 모든 명령에 전역적으로 적용됩니다. 모든 buildspec 파일 명령에 대한 사용자를 지정하지 않으려는 경우 phases 블록 중 하나에 run-as를 사용하여 단계에 명령에 대한 사용자를 지정할 수 있습니다. run-as를 지정하지 않으면 모든 명령이 루트 사용자로 실행됩니다.

env

선택적 시퀀스. 하나 이상의 사용자 지정 환경 변수에 대한 정보를 나타냅니다.

참고

중요한 정보를 보호하기 위해 CodeBuild 로그에는 다음이 숨겨져 있습니다.

env/

선택적 시퀀스. Linux 또는 Windows 운영 체제에 대해 지원되는 셸을 지정합니다.

Linux 운영 체제의 경우 지원되는 셸 태그는 다음과 같습니다.

  • bash

  • /bin/sh

Windows 운영 체제의 경우 지원되는 셸 태그는 다음과 같습니다.

  • powershell.exe

  • cmd.exe

env/variables

env가 지정된 경우 및 사용자 지정 환경 변수를 일반 텍스트로 정의하려고 할 때 필요합니다. 의 매핑을 포함합니다.key/value 스칼라를 사용합니다. 여기서 각 매핑은 일반 텍스트로 된 단일 사용자 지정 환경 변수를 나타냅니다.key 는 사용자 지정 환경 변수의 이름이고,value 변수의 값 입니다.

중요

중요한 값 (특히 AWS 액세스 키 ID 및 보안 액세스 키) 을 환경 변수에 저장하지 마십시오. 환경 변수는 CodeBuild 콘솔 및 AWS CLI와 같은 도구를 사용하여 일반 텍스트로 표시할 수 있습니다. 이 단원의 뒷부분에서 설명하는 것처럼 중요한 값의 경우 parameter-store 또는 secrets-manager 매핑을 사용하는 것이 좋습니다.

사용자가 설정한 환경 변수는 기존 환경 변수를 대체합니다. 예를 들어 Docker 이미지에 값이 my_valueMY_VAR이라는 환경 변수가 이미 포함되어 있는데, 사용자가 MY_VAR 환경 변수의 값을 other_value로 설정하면, my_valueother_value로 바뀝니다. 마찬가지로, Docker 이미지에 값이 /usr/local/sbin:/usr/local/binPATH라는 환경 변수가 이미 포함되어 있는데, 사용자가 PATH 환경 변수의 값을 $PATH:/usr/share/ant/bin으로 설정하면, /usr/local/sbin:/usr/local/bin$PATH:/usr/share/ant/bin 리터럴 값으로 바뀝니다.

CODEBUILD_로 시작하는 이름으로 환경 변수를 설정하지 마십시오. 이 접두사는 내부 전용으로 예약되어 있습니다.

여러 위치에서 동일한 이름의 환경 변수가 정의되는 경우, 다음과 같이 값이 결정됩니다.

  • 시작 빌드 작업 호출의 값이 가장 높은 우선 순위를 갖습니다. 빌드를 생성할 때 환경 변수를 추가 또는 재정의할 수 있습니다. 자세한 내용은 AWS 코드 빌드에서 빌드 실행 단원을 참조하세요.

  • 빌드 프로젝트 정의의 값이 다음 우선 순위를 갖습니다. 프로젝트를 생성 또는 편집할 때 프로젝트 수준에서 환경 변수를 추가할 수 있습니다. 자세한 내용은 AWS CodeBuildAWS CodeBuild에서 빌드 프로젝트 설정 변경 단원을 참조하십시오.

  • buildspec 선언의 값이 가장 낮은 우선 순위를 갖습니다.

env/parameter-store

필요한 경우env가 지정된 경우 및 Amazon EC2 Systems Manager 파라미터 스토어에 저장된 사용자 지정 환경 변수를 검색하려고 할 때 필요합니다. 의 매핑을 포함합니다.key/value 스칼라 (각 매핑은 Amazon EC2 Systems Manager 파라미터 스토어에 저장된 단일 사용자 지정 환경 변수를 나타냅니다.key 은 나중에 빌드 명령에서이 사용자 정의 환경 변수를 참조하기 위해 사용하는 이름이며 value Amazon EC2 Systems Manager 파라미터 스토어에 저장되는 사용자 지정 환경 변수의 이름입니다. 민감한 값을 저장하려면Systems Manager 파라미터 스토어연습 String 파라미터 생성 및 테스트 (콘솔)Amazon EC2 Systems Manager 사용 설명서를 선택합니다.

중요

CodeBuild 가 Amazon EC2 Systems Manager 파라미터 스토어에 저장된 사용자 지정 환경 변수를 검색하도록 허용하려면ssm:GetParameters작업을 CodeBuild 서비스 역할에 추가하십시오. 자세한 내용은 CodeBuild 서비스 역할을 만들려면 단원을 참조하세요.

Amazon EC2 Systems Manager 파라미터 스토어에서 검색하는 환경 변수는 기존 환경 변수를 대체합니다. 예를 들어 Docker 이미지에 값이 MY_VARmy_value이라는 환경 변수가 이미 포함되어 있는데, 사용자가 MY_VAR 환경 변수의 값을 other_value로 검색하면, my_valueother_value로 바뀝니다. 마찬가지로, Docker 이미지에 값이 PATH/usr/local/sbin:/usr/local/bin라는 환경 변수가 이미 포함되어 있는데, 사용자가 PATH 환경 변수의 값을 $PATH:/usr/share/ant/bin으로 검색하면, /usr/local/sbin:/usr/local/bin$PATH:/usr/share/ant/bin 리터럴 값으로 바뀝니다.

CODEBUILD_로 시작하는 이름으로 환경 변수를 저장하지 마십시오. 이 접두사는 내부 전용으로 예약되어 있습니다.

여러 위치에서 동일한 이름의 환경 변수가 정의되는 경우, 다음과 같이 값이 결정됩니다.

  • 시작 빌드 작업 호출의 값이 가장 높은 우선 순위를 갖습니다. 빌드를 생성할 때 환경 변수를 추가 또는 재정의할 수 있습니다. 자세한 내용은 AWS 코드 빌드에서 빌드 실행 단원을 참조하세요.

  • 빌드 프로젝트 정의의 값이 다음 우선 순위를 갖습니다. 프로젝트를 생성 또는 편집할 때 프로젝트 수준에서 환경 변수를 추가할 수 있습니다. 자세한 내용은 AWS CodeBuildAWS CodeBuild에서 빌드 프로젝트 설정 변경 단원을 참조하십시오.

  • buildspec 선언의 값이 가장 낮은 우선 순위를 갖습니다.

env/secrets-manager

AWS Secrets Manager 에 저장된 사용자 지정 환경 변수를 검색하려고 할 때 필요합니다. Secrets Manager 지정reference-key다음 패턴을 사용합니다.

<key>: <secret-id>:<json-key>:<version-stage>|<version-id>

<key>

(필수) 로컬 환경 변수 이름입니다. 빌드 중에 변수에 액세스하려면이 이름을 사용하십시오.

<secret-id>

(필수) 암호에 대한 고유 식별자 역할을 수행하는 이름 또는 Amazon 리소스 이름 (ARN) 입니다. AWS 계정의 암호에 액세스하려면 보안 암호 이름을 지정합니다. 다른 AWS 계정의 암호에 액세스하려면 암호 ARN 지정합니다.

<json-key>

(선택 사항) 검색하고자 하는 값을 보유한 Secrets Manager 키-값 페어의 키 이름을 지정합니다. 를 지정하지 않을 경우json-key이면 CodeBuild 가 전체 보안 암호를 검색합니다.

<version-stage>

(선택 사항) 버전에 연결된 레이블을 스테이징하여 검색하고자 하는 보안 암호 버전을 지정합니다. 스테이징 레이블은 교체 프로세스 도중 다른 버전을 추적하는 데 사용됩니다. version-stage를 사용하는 경우 version-id를 지정하지 마십시오. 버전 스테이지 또는 버전 ID를 지정하지 않으면 기본값은 AWSCURRENT의 버전 스테이지 값으로 버전을 검색하는 것입니다.

<version-id>

(선택 사항) 사용하고자 하는 암호 버전의 고유 식별자를 지정합니다. version-id을 지정할 경우 version-stage을 지정하지 마십시오. 버전 스테이지 또는 버전 ID를 지정하지 않으면 기본값은 AWSCURRENT의 버전 스테이지 값으로 버전을 검색하는 것입니다.

다음 예에서TestSecretSecrets Manager 저장된 키 - 값 페어의 이름입니다. 에 대 한 키TestSecret확장하는 데MY_SECRET_VAR를 선택합니다. 당신은 사용하여 빌드하는 동안 변수에 액세스LOCAL_SECRET_VAR이름을 지정합니다.

env: secrets-manager: LOCAL_SECRET_VAR: "TestSecret:MY_SECRET_VAR"

자세한 내용은 단원을 참조하십시오.AWS Secrets Manager 란 무엇입니까?AWS Secrets Manager 사용 설명서를 선택합니다.

env/exported-variables

선택적 매핑. 내보낼 환경 변수를 나열하는 데 사용됩니다. exported-variables에서 별도의 행에 내보낼 각 변수의 이름을 지정합니다. 내보낼 변수는 빌드 중에 컨테이너에서 사용할 수 있어야 합니다. 내보내는 변수는 환경 변수일 수 있습니다.

내보낸 환경 변수는 AWS CodePipeline 과 함께 사용하여 현재 빌드 단계에서 파이프라인의 후속 단계로 환경 변수를 내보냅니다. 자세한 내용은 단원을 참조하십시오.변수 작업AWS CodePipeline 사용를 선택합니다.

빌드하는 동안 변수의 값은 install 단계부터 사용할 수 있습니다. 이 값은 install 단계 시작과 post_build 단계 끝 사이에서 업데이트할 수 있습니다. post_build 단계가 끝나면 내보낸 변수의 값을 변경할 수 없습니다.

참고

다음은 내보낼 수 없습니다.

  • 빌드 프로젝트에서 지정된 Amazon EC2 Systems Manager 파라미터 스토어 암호

  • 빌드 프로젝트에서 지정된 암호

  • AWS_로 시작하는 환경 변수

env/자식 자격 증명 도우미

선택적 매핑. CodeBuild 가 Git 자격 증명 헬퍼를 사용하여 Git 자격 증명을 제공하는지를 나타내는 데 사용됩니다. yes사용 된 경우. 그렇지 않은 경우 no이거나 값이 지정되지 않은 것입니다. 자세한 내용은 Git 웹사이트의 gitcredentials를 참조하십시오.

참고

퍼블릭 Git 리포지토리에 대해 webhook에서 트리거한 빌드의 경우에는 git-credential-helper가 지원되지 않습니다.

proxy

선택적 시퀀스. 명시적 프록시 서버에서 빌드를 실행할 경우 설정을 나타내는 데 사용됩니다. 자세한 내용은 명시적 프록시 서버에서 CodeBuild 실행 단원을 참조하세요.

proxy/upload-artifacts

선택적 매핑. 명시적 프록시 서버에서 빌드가 아티팩트를 업로드하도록 하려면 yes로 설정합니다. 기본값은 no입니다.

proxy/logs

선택적 매핑. 로 설정합니다.yes가 CloudWatch 로그를 생성하도록 명시적 프록시 서버에서 빌드에 대해 설명합니다. 기본값은 no입니다.

phases

필수 시퀀스. 빌드의 각 단계 동안 CodeBuild 실행하는 명령을 나타냅니다.

참고

buildspec 버전 0.1에서, CodeBuild는 빌드 환경에 있는 기본 셸의 서로 다른 인스턴스에서 각 명령을 실행합니다. 즉, 각 명령이 다른 모든 명령과 독립적으로 실행됩니다. 따라서 기본적으로 이전 명령의 상태에 따라 실행되는 단일 명령을 실행할 수 없습니다(예: 디렉터리 변경 또는 환경 변수 설정). 이 제한 사항을 해결하려면 이 문제를 해결하는 버전 0.2를 사용하는 것이 좋습니다. buildspec 버전 0.1을 사용해야 하는 경우 빌드 환경의 셸 및 명령 단원의 접근 방식을 따르는 것이 좋습니다.

phases/*/run-as

선택적 시퀀스. 해당 명령을 실행하는 Linux 사용자를 지정하려면 빌드 단계에 사용합니다. buildspec 파일의 상단에 모든 명령에 대해 전역적으로 run-as도 지정할 경우 단계 수준 사용자가 우선 적용됩니다. 예를 들어, 전역적으로run-as은 User-1을 지정하고installa 단계만run-as문은 User-2를 지정하면 buildspec 파일의 모든 명령이 User-1로 실행됩니다.를 제외하고명령의install단계는 User-2로 실행됩니다.

단계/*/실패

선택적 시퀀스. 단계 중에 오류가 발생할 경우 수행할 작업을 지정합니다. 다음 값 중 하나일 수 있습니다.

  • ABORT- 빌드를 중단합니다.

  • CONTINUE다음 단계로 이동합니다.

이 속성을 지정하지 않으면 실패 프로세스는 다음과 같이 전환 단계를 따릅니다.빌드 단계 진행를 선택합니다.

단계/*/finally

선택적 블록. 에 지정된 명령finally블록의 명령 후에 실행 되는commands블록으로 설정합니다. 의 명령finally블록의 명령은 실행 되는 경우에도commands블록이 실패합니다. 예를 들어,commands블록에는 세 개의 명령이 포함되고 첫 번째 명령이 실패하는 경우, CodeBuild 는 나머지 두 명령을 건너뛰고finally블록으로 설정합니다. commandsfinally 블록의 모든 명령이 성공적으로 실행되면 단계가 성공합니다. 어느 단계의 명령이 하나라도 실패하면 그 단계는 실패합니다.

허용되는 빌드 단계 이름은 다음과 같습니다.

phases/install

선택적 시퀀스. 설치 중에 CodeBuild 가 실행하는 명령을 나타냅니다 (있는 경우). 빌드 환경에서 패키지를 설치하는 경우에만 install 단계를 사용하는 것이 좋습니다. 예를 들어, Mocha나 RSpec 같은 코드 테스팅 프레임워크를 설치하기 위해 이 단계를 사용할 수 있습니다.

phases/install/runtime-versions

선택적 시퀀스. 런타임 버전은 Ubuntu 표준 이미지 2.0 이상 및 Amazon Linux 2 표준 이미지 1.0 이상에서 지원됩니다. 지정된 경우 적어도 하나의 실행 시간이 이 섹션에 포함되어야 합니다. 특정 버전을 사용하여 런타임을 지정하고, 주 버전 다음에.x를 사용하여 CodeBuild 가 해당 주 버전을 최신 부 버전과 함께 사용하도록 지정하거나latest를 사용하여 최신 주 버전 및 부 버전 (예:java: openjdk11,ruby: 2.6,nodejs: 12.x또는java: latest). 숫자나 환경 변수를 사용하여 실행 시간을 지정할 수 있습니다. 예를 들어 Amazon Linux 2 표준 이미지 2.0을 사용하는 경우 다음은 Java 버전 8, Python 버전 3의 최신 마이너 버전, Ruby 환경 변수에 포함된 버전이 설치되도록 지정합니다. 자세한 내용은 CodeBuild 에서 제공하는 도커 이미지 단원을 참조하세요.

phases: install: runtime-versions: java: corretto8 python: 3.x ruby: "$MY_RUBY_VAR"

빌드 사양 파일의 runtime-versions 섹션에서 하나 이상의 런타임을 지정할 수 있습니다. 런타임이 다른 런타임에 종속되는 경우 빌드 사양 파일에서 종속 런타임을 지정할 수도 있습니다. buildspec 파일에 런타임을 지정하지 않은 경우, CodeBuild Build는 사용하는 이미지에서 사용할 수 있는 기본 런타임을 선택합니다. 하나 이상의 런타임을 지정하는 경우 CodeBuild 가 해당 런타임만을 사용합니다. 종속 런타임을 지정하지 않은 경우 CodeBuild 가 종속 런타임을 선택하려고 시도합니다.

지정된 두 실행 시간이 충돌하면 빌드가 실패합니다. 예를 들어 android: 29java: openjdk11이 충돌하므로 둘 다 지정하면 빌드가 실패합니다.

사용 가능한 런타임에 대한 자세한 내용은 단원을 참조하십시오.사용 가능한 런타임를 선택합니다.

참고

지정한 경우runtime-versions섹션을 방문하여 Ubuntu 표준 이미지 2.0 이상 또는 Amazon Linux 2 (AL2) 표준 이미지 1.0 이상 외의 이미지를 사용하는 경우, 빌드에서 “”라는 경고가 발생합니다.Skipping install of runtimes. Runtime version selection is not supported by this build image.”

phases/install/commands

선택적 시퀀스. 스칼라 시퀀스를 포함하며, 각 스칼라는 설치 중에 CodeBuild 가 실행하는 단일 명령을 나타냅니다. CodeBuild 는 처음부터 끝까지 한 번에 하나씩 나열된 순서로 각 명령을 실행합니다.

phases/pre_build

선택적 시퀀스. 빌드 전에 CodeBuild가 실행하는 명령을 나타냅니다 (있는 경우). 예를 들어, Amazon ECR에 로그인하기 위해 이 단계를 사용하거나 npm 종속성을 설치할 수 있습니다.

phases/pre_build/commands

pre_build를 지정한 경우 필수 시퀀스입니다. 스칼라 시퀀스를 포함하며, 각 스칼라는 CodeBuild가 빌드 전에 실행하는 단일 명령을 나타냅니다. CodeBuild 는 처음부터 끝까지 한 번에 하나씩 나열된 순서로 각 명령을 실행합니다.

phases/build

선택적 시퀀스. 빌드 중에 CodeBuild가 실행하는 명령을 나타냅니다 (있는 경우). 예를 들어, Mocha, RSpec 또는 sbt를 실행하기 위해 이 단계를 사용할 수 있습니다.

phases/build/commands

필요한 경우build가 지정됩니다. 스칼라 시퀀스를 포함하며, 각 스칼라는 CodeBuild 중에 가 실행하는 단일 명령을 나타냅니다. CodeBuild 는 처음부터 끝까지 한 번에 하나씩 나열된 순서로 각 명령을 실행합니다.

phases/post_build

선택적 시퀀스. 빌드 후에 CodeBuild가 실행하는 명령을 나타냅니다 (있는 경우). 예를 들어, Maven을 사용하여 빌드 결과물을 JAR 또는 WAR 파일에 패키지할 수 있으며, Docker 이미지를 Amazon ECR에 푸시할 수도 있습니다. 그런 다음 Amazon SNS 통해 빌드 알림을 전송할 수도 있습니다.

phases/post_build/commands

필요한 경우post_build가 지정됩니다. 스칼라 시퀀스를 포함하며, 각 스칼라는 CodeBuild가 빌드 후에 실행하는 단일 명령을 나타냅니다. CodeBuild 는 처음부터 끝까지 한 번에 하나씩 나열된 순서로 각 명령을 실행합니다.

reports

report-group-name-or-arn

선택적 시퀀스. 보고서를 전송할 보고서 그룹을 지정합니다. 프로젝트에는 최대 5개의 보고서 그룹이 포함될 수 있습니다. 기존 보고서 그룹의 ARN 또는 새 보고서 그룹의 이름을 지정합니다. 이름을 지정하면 CodeBuild 는 프로젝트 이름과 형식으로 지정한 이름을 사용하여 보고서 그룹을 생성합니다.<project-name>-<report-group-name>를 선택합니다. 자세한 내용은 보고서 그룹 이름 지정 단원을 참조하세요.

reports/<report-group>/files

필수 시퀀스. 보고서에 의해 생성된 테스트 결과의 원시 데이터가 포함된 위치를 나타냅니다. 스칼라 시퀀스를 포함하며, 각 스칼라는 가 CodeBuild가 원래 빌드 위치를 기준으로 테스트 파일을 찾을 수 있는 별도의 위치 또는 설정된 경우 을 나타냅니다.base-directory를 선택합니다. 위치에는 다음이 포함될 수 있습니다.

  • 단일 파일(예: my-test-report-file.json).

  • 하위 디렉터리의 단일 파일입니다(예: my-subdirectory/my-test-report-file.json 또는 my-parent-subdirectory/my-subdirectory/my-test-report-file.json).

  • '**/*'는 모든 파일을 재귀적으로 나타냅니다.

  • my-subdirectory/*는 하위 디렉터리에 있는 모든 파일을 나타냅니다.my-subdirectory.

  • my-subdirectory/**/*라는 하위 디렉터리에서 시작하는 모든 파일을 재귀적으로 나타냅니다.my-subdirectory.

reports/<report-group>/file-format

선택적 매핑. 보고서 파일 형식을 나타냅니다. 지정하지 않으면 JUNITXML가 사용됩니다. 이 값은 대소문자를 구분하지 않습니다. 가능한 값은 다음과 같습니다.

테스트 보고서

CUCUMBERJSON

Cucumber JSON

JUNITXML

JUnit XML

NUNITXML

NUnit XML

NUNIT3XML

NUnit XML

TESTNGXML

TestNG XML

VISUALSTUDIOTRX

Visual Studio TRX

코드 적용 범위 보고서

CLOVERXML

클로버 XML

COBERTURAXML

코베르투라

JACOCOXML

JaCoCo XML

SIMPLECOV

JSOSimpleCov

참고

CodeBuild 생성 된 JSON 코드 커버리지 보고서를 허용합니다.분류: 심플레코프, 하지JSON 심플코브를 선택합니다.

보고서/<report-group>/기본 디렉터리

선택적 매핑. CodeBuild가 원시 테스트 파일을 찾을 위치를 결정할 때 사용하는 원래 빌드 위치를 기준으로 하나 이상의 최상위 디렉터리를 나타냅니다.

reports/<report-group>/discard-paths

선택 사항입니다. 보고서 파일 디렉터리가 출력에서 평면화되는지 여부를 지정합니다. 이 값이 지정되지 않거나 no를 포함하는 경우 보고서 파일은 디렉터리 구조가 손상되지 않은 상태로 출력됩니다. yes가 포함된 경우 모든 테스트 파일이 동일한 출력 디렉터리에 배치됩니다. 예를 들어, 테스트 결과에 대한 경로가 com/myapp/mytests/TestResult.xml인 경우 yes를 지정하면 이 파일이 /TestResult.xml에 배치됩니다.

artifacts

선택적 시퀀스. CodeBuild 출력을 찾을 수 있는 위치 및 CodeBuild가 S3 출력 버킷에 업로드하기 위해 빌드 출력을 준비하는 방식에 대한 정보를 나타냅니다. Docker 이미지를 빌드하여 Amazon ECR에 푸시하는 경우 또는 소스 코드에 단위 테스트를 실행하고 빌드는 하지 않는 경우 등에 이 시퀀스가 필요하지 않습니다.

artifacts/files

필수 시퀀스. 빌드 환경의 빌드 출력 결과물을 포함하는 위치를 나타냅니다. 스칼라 시퀀스를 포함하며, 각 스칼라는 가 CodeBuild 출력 결과물을 찾을 수 있는 개별 위치를 원래 빌드 위치 또는 기본 디렉터리 (설정한 경우) 를 기준으로 나타냅니다. 위치에는 다음이 포함될 수 있습니다.

  • 단일 파일(예: my-file.jar).

  • 하위 디렉터리의 단일 파일입니다(예: my-subdirectory/my-file.jar 또는 my-parent-subdirectory/my-subdirectory/my-file.jar).

  • '**/*'는 모든 파일을 재귀적으로 나타냅니다.

  • my-subdirectory/*는 하위 디렉터리에 있는 모든 파일을 나타냅니다.my-subdirectory.

  • my-subdirectory/**/*라는 하위 디렉터리에서 시작하는 모든 파일을 재귀적으로 나타냅니다.my-subdirectory.

빌드 출력 결과물 위치를 지정하면 CodeBuild는 빌드 환경에 있는 원래 빌드 위치를 찾을 수 있습니다. 빌드 결과물 출력 위치 앞에 원래 빌드 위치 경로를 추가하거나 ./ 같은 것을 지정하지 않아도 됩니다. 이 위치에 대한 경로를 알고 싶으면 빌드 중에 echo $CODEBUILD_SRC_DIR과 같은 명령을 실행하면 됩니다. 각 빌드 환경의 위치는 약간씩 다를 수 있습니다.

artifacts/name

선택적 이름. 빌드 결과물의 이름을 지정합니다. 이 이름은 다음 중 하나에 해당될 때 사용됩니다.

  • CodeBuild API를 사용하여 빌드를 만들고overrideArtifactName플래그가 설정되어 있는ProjectArtifacts프로젝트가 업데이트되거나 생성되거나 빌드가 시작될 때 객체가 업데이트되거나 빌드가 시작될 때 입니다.

  • CodeBuild 콘솔을 사용하여 빌드를 생성하면 buildspec 파일에 이름이 지정되고의미 체계 버전 관리 사용프로젝트를 만들거나 업데이트할 때 사용합니다. 자세한 내용은 빌드 프로젝트 만들기(콘솔) 단원을 참조하세요.

빌드할 때 계산되는 buildspec 파일에서 이름을 지정할 수 있습니다. buildspec 파일에 지정된 이름은 Shell 명령 언어를 사용합니다. 예를 들어 결과물 이름이 항상 고유하도록 날짜와 시간을 결과물 이름에 추가할 수 있습니다. 고유한 결과물 이름을 사용하면 결과물을 덮어쓰지 않을 수 있습니다. 자세한 정보는 Shell 명령 언어를 참조하십시오.

  • 다음은 아티팩트가 생성된 날짜가 추가된 아티팩트 이름의 예입니다

    version: 0.2 phases: build: commands: - rspec HelloWorld_spec.rb artifacts: files: - '**/*' name: myname-$(date +%Y-%m-%d)
  • 다음은 CodeBuild 환경 변수를 사용하는 아티팩트 이름의 예입니다. 자세한 내용은 빌드 환경의 환경 변수 단원을 참조하세요.

    version: 0.2 phases: build: commands: - rspec HelloWorld_spec.rb artifacts: files: - '**/*' name: myname-$AWS_REGION
  • 다음은 CodeBuild 환경 변수를 사용하여 결과물 생성 날짜가 추가된 결과물 이름의 예입니다.

    version: 0.2 phases: build: commands: - rspec HelloWorld_spec.rb artifacts: files: - '**/*' name: $AWS_REGION-$(date +%Y-%m-%d)

이름에 경로 정보를 추가하여 이름이 지정된 객체가 이름의 경로를 기반으로 디렉토리에 배치되도록 할 수 있습니다. 이 예에서 빌드 아티팩트는 아래 출력에 배치됩니다.builds/<build number>/my-artifacts를 선택합니다.

version: 0.2 phases: build: commands: - rspec HelloWorld_spec.rb artifacts: files: - '**/*' name: builds/$CODEBUILD_BUILD_NUMBER/my-artifacts
artifacts/discard-paths

선택 사항입니다. 빌드 아티팩트 디렉터리가 출력에서 평면화되는지 여부를 지정합니다. 이 값이 지정되지 않거나 no를 포함하는 경우 빌드 아티팩트는 디렉터리 구조가 손상되지 않은 상태로 출력됩니다. yes가 포함된 경우 모든 빌드 아티팩트가 동일한 출력 디렉터리에 배치됩니다. 예를 들어, 빌드 출력 아티팩트의 파일 경로가 com/mycompany/app/HelloWorld.java인 경우 yes를 지정하면 이 파일이 /HelloWorld.java에 배치됩니다.

artifacts/base-directory

선택적 매핑. CodeBuild Build가 빌드 출력 결과물에 포함할 파일 및 하위 디렉터리를 결정할 때 사용하는 원래 빌드 위치를 기준으로 하나 이상의 최상위 디렉터리를 나타냅니다. 유효한 값으로는 다음이 포함됩니다.

  • 단일 최상위 디렉터리입니다(예: my-directory).

  • 'my-directory*'는 이름이 my-directory로 시작하는 모든 최상위 디렉터리를 나타냅니다.

빌드 출력 결과물에는 이 최상위 디렉터리가 포함되지 않으며, 파일 및 하위 디렉터리만 포함됩니다.

포함할 파일 및 하위 디렉터리를 보다 더 제한하려면 filesdiscard-paths를 사용하면 됩니다. 예를 들어 다음 디렉터리구조에서

. ├── my-build-1 │ └── my-file-1.txt └── my-build-2 ├── my-file-2.txt └── my-subdirectory └── my-file-3.txt

다음 artifacts 시퀀스에 대해:

artifacts: files: - '*/my-file-3.txt' base-directory: my-build-2

다음 하위 디렉터리 및 파일이 빌드 출력 결과물에 포함됩니다.

. └── my-subdirectory └── my-file-3.txt

다음 artifacts 시퀀스 동안

artifacts: files: - '**/*' base-directory: 'my-build*' discard-paths: yes

다음 파일이 빌드 출력 결과물에 포함됩니다.

. ├── my-file-1.txt ├── my-file-2.txt └── my-file-3.txt
/아티팩트제외-경로

선택적 매핑. 상대 하나 이상의 경로를 나타냅니다base-directory이면 CodeBuild 는 빌드 아티팩트에서 제외됩니다.

/아티팩트심볼릭 링크

선택 사항입니다. 출력 유형이ZIP는 내부 심볼 링크가 ZIP 파일에 유지되는지 여부를 지정합니다. 이 항목이 포함된 경우yes로 설정하면 소스의 모든 내부 심볼 링크가 아티팩트 ZIP 파일에 보존됩니다.

/아티팩트s3-접두어

선택 사항입니다. 객체가 Amazon S3 버킷으로 출력되고 네임스페이스 유형이BUILD_ID를 선택합니다. 사용 시 버킷의 출력 경로는<s3-prefix>/<build-id>/<name>.zip를 선택합니다.

artifacts/secondary-artifacts

선택적 시퀀스. 1개 이상의 아티팩트 정의를 아티팩트 식별자와 아티팩트 정의를 연결하는 매핑으로 나타냅니다. 이 블록에서는 각 아티팩트가 프로젝트의 secondaryArtifacts 속성에서 정의하는 아티팩트와 일치해야 합니다. 각 정의는 위의 artifacts 블록과 동일한 구문을 갖습니다.

참고

artifacts/files시퀀스는 보조 아티팩트 만 정의 된 경우에도 항상 필요합니다.

예를 들어 프로젝트가 다음과 같은 구조라고 가정할 경우,

{ "name": "sample-project", "secondaryArtifacts": [ { "type": "S3", "location": "output-bucket1", "artifactIdentifier": "artifact1", "name": "secondary-artifact-name-1" }, { "type": "S3", "location": "output-bucket2", "artifactIdentifier": "artifact2", "name": "secondary-artifact-name-2" } ] }

buildpec 파일은 다음과 비슷합니다.

version: 0.2 phases: build: commands: - echo Building... artifacts: files: - '**/*' secondary-artifacts: artifact1: files: - directory/file1 name: secondary-artifact-name-1 artifact2: files: - directory/file2 name: secondary-artifact-name-2

cache

선택적 시퀀스. CodeBuild 가 S3 캐시 버킷에 캐시를 업로드하기 위해 준비할 수 있는 파일에 대한 정보를 나타냅니다. 프로젝트의 캐시 유형이 No Cache인 경우 이 시퀀스는 필수가 아닙니다.

cache/paths

필수 시퀀스. 캐시의 위치를 나타냅니다. 스칼라 시퀀스를 포함하며, 각 스칼라는 가 CodeBuild 출력 결과물을 찾을 수 있는 개별 위치를 원래 빌드 위치 또는 기본 디렉터리 (설정한 경우) 를 기준으로 나타냅니다. 위치에는 다음이 포함될 수 있습니다.

  • 단일 파일(예: my-file.jar).

  • 하위 디렉터리의 단일 파일입니다(예: my-subdirectory/my-file.jar 또는 my-parent-subdirectory/my-subdirectory/my-file.jar).

  • '**/*'는 모든 파일을 재귀적으로 나타냅니다.

  • my-subdirectory/*는 하위 디렉터리에 있는 모든 파일을 나타냅니다.my-subdirectory.

  • my-subdirectory/**/*라는 하위 디렉터리에서 시작하는 모든 파일을 재귀적으로 나타냅니다.my-subdirectory.

중요

buildspec 선언은 올바른 YAML이어야 하므로 buildspec 선언의 공백 설정이 중요합니다. buildspec 선언의 공백 수가 잘못되면 빌드가 즉시 실패할 수 있습니다. YAML 유효성 검사기를 사용하여 buildspec 선언이 올바른 YAML인지 여부를 테스트할 수 있습니다.

빌드 프로젝트를 생성하거나 업데이트할 때 또는 AWS SDK를 사용하여 buildspec을 선언하는 경우, buildspec은 필수 공백 및 줄바꿈 이스케이프 문자를 포함하여 YAML 형식으로 표현된 단일 문자열이어야 합니다. 다음 섹션에 예가 나와 있습니다.

buildspec.yml 파일 대신 CodeBuild 또는 AWS CodePipeline 콘솔을 사용하는 경우,build단계만 사용합니다. 앞에 나온 구문을 사용하는 대신, 빌드 단계 중에 실행하려는 모든 명령을 하나의 행에 나열합니다. 명령이 여러 개인 경우 각 명령을 &&로 구분합니다(예: mvn test && mvn package).

buildspec.yml 파일 대신 CodeBuild 또는 CodePipeline 콘솔을 사용하여 빌드 환경에 있는 빌드 출력 결과물 위치를 지정할 수 있습니다. 앞에 나온 구문을 사용하는 대신, 모든 위치를 하나의 행에 나열합니다. 위치가 여러 개인 경우 각 위치를 쉼표로 구분합니다(예: buildspec.yml, target/my-app.jar).

buildspec 예제

다음은 buildspec.yml 파일의 예입니다.

version: 0.2 env: variables: JAVA_HOME: "/usr/lib/jvm/java-8-openjdk-amd64" parameter-store: LOGIN_PASSWORD: /CodeBuild/dockerLoginPassword phases: install: commands: - echo Entered the install phase... - apt-get update -y - apt-get install -y maven finally: - echo This always runs even if the update or install command fails pre_build: commands: - echo Entered the pre_build phase... - docker login -u User -p $LOGIN_PASSWORD finally: - echo This always runs even if the login command fails build: commands: - echo Entered the build phase... - echo Build started on `date` - mvn install finally: - echo This always runs even if the install command fails post_build: commands: - echo Entered the post_build phase... - echo Build completed on `date` reports: arn:aws:codebuild:your-region:your-aws-account-id:report-group/report-group-name-1: files: - "**/*" base-directory: 'target/tests/reports' discard-paths: no reportGroupCucumberJson: files: - 'cucumber/target/cucumber-tests.xml' discard-paths: yes file-format: CUCUMBERJSON # default is JUNITXML artifacts: files: - target/messageUtil-1.0.jar discard-paths: yes secondary-artifacts: artifact1: files: - target/artifact-1.0.jar discard-paths: yes artifact2: files: - target/artifact-2.0.jar discard-paths: yes cache: paths: - '/root/.m2/**/*'

다음은 앞에 나온 buildspec의 예로, AWS CLI 또는 AWS SDK에서 사용할 수 있도록 단일 문자열로 표현한 것입니다.

"version: 0.2\n\nenv:\n variables:\n JAVA_HOME: \"/usr/lib/jvm/java-8-openjdk-amd64\\"\n parameter-store:\n LOGIN_PASSWORD: /CodeBuild/dockerLoginPassword\n phases:\n\n install:\n commands:\n - echo Entered the install phase...\n - apt-get update -y\n - apt-get install -y maven\n finally:\n - echo This always runs even if the update or install command fails \n pre_build:\n commands:\n - echo Entered the pre_build phase...\n - docker login -u User -p $LOGIN_PASSWORD\n finally:\n - echo This always runs even if the login command fails \n build:\n commands:\n - echo Entered the build phase...\n - echo Build started on `date`\n - mvn install\n finally:\n - echo This always runs even if the install command fails\n post_build:\n commands:\n - echo Entered the post_build phase...\n - echo Build completed on `date`\n\n reports:\n reportGroupJunitXml:\n files:\n - \"**/*\"\n base-directory: 'target/tests/reports'\n discard-paths: false\n reportGroupCucumberJson:\n files:\n - 'cucumber/target/cucumber-tests.xml'\n file-format: CUCUMBERJSON\n\nartifacts:\n files:\n - target/messageUtil-1.0.jar\n discard-paths: yes\n secondary-artifacts:\n artifact1:\n files:\n - target/messageUtil-1.0.jar\n discard-paths: yes\n artifact2:\n files:\n - target/messageUtil-1.0.jar\n discard-paths: yes\n cache:\n paths:\n - '/root/.m2/**/*'"

다음은 명령의 예입니다.build단계에서 코드 빌드 또는 CodePipeline 콘솔과 함께 사용할 수 있습니다.

echo Build started on `date` && mvn install

아래 예에서

  • JAVA_HOME의 키 및 /usr/lib/jvm/java-8-openjdk-amd64의 값이 있는 일반 텍스트의 사용자 지정 환경 변수가 설정됩니다.

  • 라는 사용자 지정 환경 변수dockerLoginPasswordAmazon EC2 Systems Manager 파라미터 스토어에 저장한 내용은 나중에 키를 사용하여 빌드 명령에서 참조됩니다.LOGIN_PASSWORD를 선택합니다.

  • 이러한 빌드 단계 이름은 변경할 수 없습니다. 이 예제에서 실행 되는 명령은apt-get update -yapt-get install -y maven(아파치 메이븐 설치),mvn install(소스 코드를 빌드 출력 결과물에 컴파일하고 테스트하고 패키지하고 내부 저장소에 빌드 출력 결과물을 설치하려고 할 때),docker login(사용자 지정 환경 변수의 값에 해당하는 암호로 Docker에 로그인하려면dockerLoginPasswordAmazon EC2 Systems Manager 파라미터 스토어에 설정한 경우) 및 여러echo명령을 사용합니다. 이echo명령은 CodeBuild 가 명령을 실행하는 방식 및 명령을 실행하는 순서를 보여 주기 위해 포함된 것입니다.

  • files는 빌드 출력 위치에 업로드할 파일을 나타냅니다. 이 예에서 CodeBuild 는 단일 파일을 업로드합니다.messageUtil-1.0.jar를 선택합니다. messageUtil-1.0.jar 파일은 빌드 환경의 target이라는 상대적 디렉터리에서 찾을 수 있습니다. discard-paths: yes가 지정되어 있으므로, messageUtil-1.0.jar가 바로 업로드됩니다(중간의 target 디렉터리를 거치지 않음). 파일 이름 messageUtil-1.0.jar 및 상대적 디렉터리 이름 target은 Apache Maven이 이 예제에서만 빌드 출력 결과물을 생성 및 저장하는 방식에 따라 달라집니다. 사용자 자체 시나리오에서는 이러한 파일 이름과 디렉터리가 다릅니다.

  • reports는 빌드 중에 보고서를 생성하는 두 개의 보고서 그룹을 나타냅니다.

    • arn:aws:codebuild:your-region:your-aws-account-id:report-group/report-group-name-1는 보고서 그룹의 ARN을 지정합니다. 테스트 프레임워크에 의해 생성된 테스트 결과는 target/tests/reports 디렉터리에 있습니다. 파일 형식은 JunitXml이고 테스트 결과가 포함된 파일에서 경로가 제거되지 않습니다.

    • reportGroupCucumberJson는 새 보고서 그룹을 지정합니다. 프로젝트 이름이 my-project인 경우 빌드가 실행될 때 이름이 my-project-reportGroupCucumberJson인 보고서 그룹이 생성됩니다. 테스트 프레임워크에 의해 생성된 테스트 결과가 cucumber/target/cucumber-tests.xml에 있습니다. 테스트 파일 형식은 CucumberJson이고 테스트 결과가 포함된 파일에서 경로가 제거됩니다.

buildspec 버전

다음 표에는 buildspec 버전과 버전 간의 변경 사항이 나열되어 있습니다.

버전 변경
0.2
  • environment_variables의 이름이 env로 다시 지정되었습니다.

  • plaintext의 이름이 variables로 다시 지정되었습니다.

  • artifactstype 속성이 사용 중단되었습니다.

  • 버전 0.1에서 AWS CodeBuild d는 빌드 환경에 있는 기본 셸의 서로 다른 인스턴스에서 각 빌드 명령을 실행합니다. 버전 0.2에서 CodeBuild d는 빌드 환경에 있는 기본 셸의 동일한 인스턴스에서 모든 빌드 명령을 실행합니다.

0.1 이는 빌드 사양 형식의 초기 정의입니다.