이 주제에서는 빌드 사양(buildspec) 파일에 대한 중요한 참조 정보를 제공합니다. buildspec은 CodeBuild가 빌드를 실행하는 데 사용하는 YAML 형식의 빌드 명령 및 관련 설정의 모음입니다. 소스 코드의 일부로 buildspec을 포함하거나, 빌드 프로젝트를 생성할 때 buildspec을 정의할 수 있습니다. 빌드 사양의 작동 방식에 대한 자세한 정보는 CodeBuild 작동 방식 단원을 참조하십시오.
buildspec 파일 이름 및 스토리지 위치
buildspec을 소스 코드의 일부로 포함하는 경우, 기본적으로 buildspec 파일에 buildspec.yml
이라는 이름을 지정해야 하며 이 파일을 소스 디렉터리의 루트에 배치해야 합니다.
기본 buildspec 파일 이름과 위치를 재정의할 수 있습니다. 예를 들어, 다음을 수행할 수 있습니다.
-
동일한 리포지토리의 다른 빌드에 대해
buildspec_debug.yml
및buildspec_release.yml
과 같은 다른 buildspec 파일을 사용합니다. -
buildspec 파일을
config/buildspec.yml
과 같은 소스 디렉터리의 루트가 아닌 다른 위치 또는 S3 버킷에 저장합니다. S3 버킷은 빌드 프로젝트와 동일한 AWS 리전에 있어야 합니다. ARN을 사용하여 buildspec 파일을 지정합니다(예:arn:aws:s3:::
).<my-codebuild-sample2>
/buildspec.yml
buildspec 파일의 이름과 상관없이, 한 빌드 프로젝트에 대해 하나의 buildspec만 지정할 수 있습니다.
기본 buildspec 파일 이름이나 위치 또는 둘 다를 재정의하려면 다음 중 하나를 수행합니다.
-
buildspec
값을 내장 환경 변수CODEBUILD_SRC_DIR
의 값에 상대적인 대체 buildspec 파일의 경로로 설정하여 AWS CLIcreate-project
또는update-project
명령을 실행합니다. 또한 AWS SDK의create project
작업과 동등한 작업을 수행할 수 있습니다. 자세한 내용은 빌드 프로젝트 생성 또는 빌드 프로젝트 설정 변경을 참조하세요. -
buildspecOverride
값을 내장 환경 변수CODEBUILD_SRC_DIR
의 값에 상대적인 대체 buildspec 파일의 경로로 설정하여 AWS CLIstart-build
명령을 실행합니다. 또한 AWS SDK의start build
작업과 동등한 작업을 수행할 수 있습니다. 자세한 내용은 빌드를 수동으로 실행 단원을 참조하십시오. -
AWS CloudFormation 템플릿에서
AWS::CodeBuild::Project
유형의 리소스에 있는Source
의BuildSpec
속성을 내장 환경 변수CODEBUILD_SRC_DIR
의 값에 상대적인 대체 buildspec 파일의 경로로 설정합니다. 자세한 내용은 AWS CloudFormation 사용 설명서의 AWS CodeBuild 프로젝트 소스에서 BuildSpec 속성을 참조하세요.
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 로그에 다음 항목이 숨겨져 있습니다.
-
AWS액세스 키 ID: 자세한 내용은 AWS Identity and Access Management 사용 설명서에서 IAM 사용자의 액세스 키 관리를 참조하세요.
-
파라미터 스토어를 사용하여 지정된 문자열입니다. 자세한 내용은 Amazon EC2 Systems Manager 사용 설명서의 Systems Manager Parameter Store 및 Systems Manager Parameter Store 콘솔 연습을 참조하세요.
-
AWS Secrets Manager을 사용하여 지정한 문자열입니다. 자세한 내용은 키 관리 단원을 참조하십시오.
- env/shell
-
선택적 시퀀스. Linux 또는 Windows 운영 체제에서 지원되는 쉘을 지정합니다.
Linux 운영 체제의 경우 지원되는 쉘 태그는 다음과 같습니다.
-
bash
-
/bin/sh
Windows 운영 체제의 경우 지원되는 쉘 태그는 다음과 같습니다.
-
powershell.exe
-
cmd.exe
-
- env/variables
-
env
가 지정된 경우 및 사용자 지정 환경 변수를 일반 텍스트로 정의하려고 할 때 필요합니다.key
/value
스칼라 매핑을 포함하며, 각 매핑은 일반 텍스트의 단일 사용자 지정 환경 변수를 나타냅니다.key
는 사용자 지정 환경 변수의 이름이고,value
는 이 변수의 값입니다.중요
중요한 값을 환경 변수에 저장하지 마세요. 환경 변수는 CodeBuild 콘솔 및 AWS CLI와 같은 도구를 사용하여 일반 텍스트로 표시할 수 있습니다. 이 단원의 뒷부분에서 설명하는 것처럼 중요한 값의 경우
parameter-store
또는secrets-manager
매핑을 사용하는 것이 좋습니다.사용자가 설정한 환경 변수는 기존 환경 변수를 대체합니다. 예를 들어 도커 이미지에 값이
my_value
인MY_VAR
이라는 환경 변수가 이미 포함되어 있는데, 사용자가MY_VAR
환경 변수의 값을other_value
로 설정하면,my_value
가other_value
로 바뀝니다. 마찬가지로, 도커 이미지에 값이/usr/local/sbin:/usr/local/bin
인PATH
라는 환경 변수가 이미 포함되어 있는데, 사용자가PATH
환경 변수의 값을$PATH:/usr/share/ant/bin
으로 설정하면,/usr/local/sbin:/usr/local/bin
이$PATH:/usr/share/ant/bin
리터럴 값으로 바뀝니다.CODEBUILD_
로 시작하는 이름으로 환경 변수를 설정하지 마십시오. 이 접두사는 내부 전용으로 예약되어 있습니다.여러 위치에서 동일한 이름의 환경 변수가 정의되는 경우, 다음과 같이 값이 결정됩니다.
-
시작 빌드 작업 호출의 값이 가장 높은 우선 순위를 갖습니다. 빌드를 생성할 때 환경 변수를 추가 또는 재정의할 수 있습니다. 자세한 내용은 AWS CodeBuild 빌드를 수동으로 실행 단원을 참조하십시오.
-
빌드 프로젝트 정의의 값이 다음 우선 순위를 갖습니다. 프로젝트를 생성 또는 편집할 때 프로젝트 수준에서 환경 변수를 추가할 수 있습니다. 자세한 내용은 AWS CodeBuild에서 빌드 프로젝트 생성 및 AWS CodeBuild에서 빌드 프로젝트 설정 변경 단원을 참조하세요.
-
buildspec 선언의 값이 가장 낮은 우선 순위를 갖습니다.
-
- env/parameter-store
-
env
가 지정되었으며 Amazon EC2 Systems Manager Parameter Store에 저장된 사용자 지정 환경 변수를 검색하려고 할 때 필요합니다.key
/value
스칼라 매핑을 포함하며, 각 매핑은 Amazon EC2 Systems Manager Parameter Store에 저장된 하나의 사용자 지정 환경 변수를 나타냅니다.key
는 이 사용자 지정 환경 변수를 참조하기 위해 나중에 빌드 명령에서 사용할 이름이고,value
는 Amazon EC2 Systems Manager Parameter Store에 저장되는 사용자 지정 환경 변수의 이름입니다. 중요한 값을 저장하려면 Amazon EC2 Systems Manager 사용 설명서의 Systems Manager Parameter Store 및 안내: 문자열 파라미터 생성 및 테스트(콘솔)를 참조하세요.중요
CodeBuild가 Amazon EC2 Systems Manager Parameter Store에 저장된 사용자 지정 환경 변수를 검색하도록 허용하려면
ssm:GetParameters
작업을 CodeBuild 서비스 역할에 추가해야 합니다. 자세한 내용은 CodeBuild가 다른 AWS 서비스와 상호 작용하도록 허용 단원을 참조하십시오.Amazon EC2 Systems Manager Parameter Store에서 검색하는 환경 변수는 기존 환경 변수를 대체합니다. 예를 들어 도커 이미지에 값이
MY_VAR
인my_value
이라는 환경 변수가 이미 포함되어 있는데, 사용자가MY_VAR
환경 변수의 값을other_value
로 검색하면,my_value
가other_value
로 바뀝니다. 마찬가지로, 도커 이미지에 값이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 CodeBuild 빌드를 수동으로 실행 단원을 참조하십시오.
-
빌드 프로젝트 정의의 값이 다음 우선 순위를 갖습니다. 프로젝트를 생성 또는 편집할 때 프로젝트 수준에서 환경 변수를 추가할 수 있습니다. 자세한 내용은 AWS CodeBuild에서 빌드 프로젝트 생성 및 AWS 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
의 버전 스테이지 값으로 버전을 검색하는 것입니다.
다음 예제에서
TestSecret
은 Secrets 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 Parameter Store 보안 암호
-
빌드 프로젝트에서 지정된 Secrets Manager 보안 암호
-
AWS_
로 시작하는 환경 변수
-
- env/git-credential-helper
-
선택적 매핑. CodeBuild가 Git 보안 인증 도우미를 사용하여 Git 보안 인증을 제공하는지를 나타내는 데 사용됩니다. Git 보안 인증 도우미가 사용되는 경우
yes
입니다. 그렇지 않은 경우no
이거나 값이 지정되지 않은 것입니다. 자세한 내용은 Git 웹사이트의 gitcredentials를 참조하십시오. 참고
퍼블릭 Git 리포지토리에 대해 webhook에서 트리거한 빌드의 경우에는
git-credential-helper
가 지원되지 않습니다.
proxy
선택적 시퀀스. 명시적 프록시 서버에서 빌드를 실행할 경우 설정을 나타내는 데 사용됩니다. 자세한 내용은 명시적 프록시 서버에서 CodeBuild 실행 단원을 참조하십시오.
- proxy/upload-artifacts
-
선택적 매핑. 명시적 프록시 서버에서 빌드가 아티팩트를 업로드하도록 하려면
yes
로 설정합니다. 기본값은no
입니다. - proxy/logs
-
선택적 매핑. 명시적 프록시 서버에서 빌드에 대해
yes
로 설정하여 CloudWatch 로그를 생성합니다. 기본값은no
입니다.
단계
필수 시퀀스. 빌드의 각 단계 동안 CodeBuild가 실행하는 명령을 나타냅니다.
참고
buildspec 버전 0.1에서 CodeBuild는 빌드 환경에 있는 기본 쉘의 개별 인스턴스에서 각 명령을 실행합니다. 즉, 각 명령이 다른 모든 명령과 독립적으로 실행됩니다. 따라서 기본적으로 이전 명령의 상태에 따라 실행되는 단일 명령을 실행할 수 없습니다(예: 디렉터리 변경 또는 환경 변수 설정). 이 제한 사항을 해결하려면 이 문제를 해결하는 버전 0.2를 사용하는 것이 좋습니다. buildspec 버전 0.1을 사용해야 하는 경우 빌드 환경의 쉘 및 명령 단원의 접근 방식을 따르는 것이 좋습니다.
- phases/*/run-as
-
선택적 시퀀스. 해당 명령을 실행하는 Linux 사용자를 지정하려면 빌드 단계에 사용합니다. buildspec 파일의 상단에 모든 명령에 대해 전역적으로
run-as
도 지정할 경우 단계 수준 사용자가 우선 적용됩니다. 예를 들어 전체적으로run-as
에서 User-1을 지정하고 해당install
단계에 대해서만run-as
명령문이 User-2를 지정하는 경우, 해당install
단계의 명령이 User-2로 실행되는 것을 제외하고 buildspec 파일의 모든 명령은 User-1으로 실행됩니다. - phases/*/on-failure
-
선택적 시퀀스. 단계 중에 오류가 발생할 경우 수행할 작업을 지정합니다. 다음 값 중 하나일 수 있습니다:
-
ABORT
- 빌드를 중단합니다. -
CONTINUE
- 다음 단계를 계속 진행합니다.
이 속성을 지정하지 않으면 오류 프로세스는 빌드 단계 진행에 표시된 전환 단계를 따릅니다.
-
- phases/*/finally
-
선택적 블록.
finally
블록에 지정된 명령은commands
블록의 명령 후에 실행됩니다.finally
블록의 명령은commands
블록의 명령이 실패할 경우에도 실행됩니다. 예를 들어 명령 3개가 포함된commands
블록에서 첫 번째 명령이 실패할 경우, CodeBuild는 나머지 두 명령을 건너뛰고finally
블록의 명령을 실행합니다.commands
및finally
블록의 모든 명령이 성공적으로 실행되면 단계가 성공합니다. 어느 단계의 명령이 하나라도 실패하면 그 단계는 실패합니다.
허용되는 빌드 단계 이름은 다음과 같습니다.
- phases/install
-
선택적 시퀀스. 설치 중에 CodeBuild가 실행하는 명령을 나타냅니다(있는 경우). 빌드 환경에서 패키지를 설치하는 경우에만
install
단계를 사용하는 것이 좋습니다. 예를 들어, Mocha나 RSpec 같은 코드 테스팅 프레임워크를 설치하기 위해 이 단계를 사용할 수 있습니다.- phases/install/runtime-versions
-
선택적 시퀀스. 런타임 버전은 Ubuntu 표준 이미지 5.0 이상 및 Amazon Linux 2 표준 이미지 4.0 이상에서 지원됩니다. 지정된 경우 적어도 하나의 실행 시간이 이 섹션에 포함되어야 합니다. 특정 버전을 사용하여 런타임을 지정하거나, 주 버전 다음에
.x
를 사용하여 CodeBuild가 주 버전을 해당 최신 부 버전과 함께 사용하도록 지정하거나, 최신 주 버전 및 부 버전을 사용하도록latest
합니다(예:ruby: 3.2
,nodejs: 18.x
또는java: latest
). 숫자나 환경 변수를 사용하여 실행 시간을 지정할 수 있습니다. 예를 들어 Amazon Linux 2 표준 이미지 4.0을 사용하는 경우 다음은 Java 버전 17, Python 버전 3의 최신 부 버전, Ruby 환경 변수에 포함된 버전이 설치되도록 지정합니다. 자세한 내용은 CodeBuild가 제공하는 도커 이미지 단원을 참조하십시오.phases: install: runtime-versions: java: corretto8 python: 3.x ruby: "$MY_RUBY_VAR"
빌드 사양 파일의
runtime-versions
섹션에서 하나 이상의 런타임을 지정할 수 있습니다. 런타임이 다른 런타임에 종속되는 경우 빌드 사양 파일에서 종속 런타임을 지정할 수도 있습니다. buildspec 파일에 런타임을 지정하지 않은 경우 CodeBuild에서는 사용하는 이미지에서 사용할 수 있는 기본 런타임을 선택합니다. 하나 이상의 런타임을 지정하는 경우 CodeBuild에서는 해당 런타임만 사용합니다. 종속 런타임을 지정하지 않은 경우 CodeBuild에서 종속 런타임을 선택하려고 시도합니다.지정된 두 실행 시간이 충돌하면 빌드가 실패합니다. 예를 들어
android: 29
와java: 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 파일에 패키지할 수 있으며, Amazon ECR에 도커 이미지를 푸시할 수도 있습니다. 그런 다음, Amazon SNS를 통해 빌드 알림을 전송할 수도 있습니다.
- phases/post_build/commands
-
post_build
를 지정한 경우 필수입니다. 스칼라 시퀀스를 포함합니다. 여기서 각 스칼라는 CodeBuild가 빌드 후에 실행하는 단일 명령을 나타냅니다. 빌드 단계마다, CodeBuild는 처음부터 끝까지 한 번에 하나씩 나열된 순서로 각 명령을 실행합니다.
보고서
- report-group-name-or-arn
-
선택적 시퀀스. 보고서를 전송할 보고서 그룹을 지정합니다. 프로젝트에는 최대 5개의 보고서 그룹이 포함될 수 있습니다. 기존 보고서 그룹의 ARN 또는 새 보고서 그룹의 이름을 지정합니다. 이름을 지정하는 경우 CodeBuild는 프로젝트 이름과
<project-name>-<report-group-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 3 XML
-
TESTNGXML
-
TestNG XML
-
VISUALSTUDIOTRX
-
Visual Studio TRX
코드 범위 보고서
-
CLOVERXML
-
Clover XML
-
COBERTURAXML
-
Cobertura XML
-
JACOCOXML
-
JacoCo XML
-
SIMPLECOV
-
SimpleCov JSON
참고
CodeBuild는 simplecov-json
이 아닌 simplecov 에서 생성된 JSON 코드 범위 보고서를 수락합니다.
-
- 보고서/<report-group>/기본 디렉터리
-
선택적 매핑. 원시 테스트 파일을 찾을 위치를 결정할 때 CodeBuild가 사용하는 원래 빌드 위치를 기준으로 하나 이상의 최상위 디렉터리를 나타냅니다.
- reports/<report-group>/discard-paths
-
선택 사항입니다. 보고서 파일 디렉터리가 출력에서 평면화되는지 여부를 지정합니다. 이 값이 지정되지 않거나
no
를 포함하는 경우 보고서 파일은 디렉터리 구조가 손상되지 않은 상태로 출력됩니다.yes
가 포함된 경우 모든 테스트 파일이 동일한 출력 디렉터리에 배치됩니다. 예를 들어, 테스트 결과에 대한 경로가com/myapp/mytests/TestResult.xml
인 경우yes
를 지정하면 이 파일이/TestResult.xml
에 배치됩니다.
artifacts
선택적 시퀀스. CodeBuild가 빌드 출력을 찾을 수 있는 위치 및 CodeBuild가 S3 출력 버킷에 업로드하기 위해 빌드 출력을 준비하는 방식에 대한 정보를 나타냅니다. 도커 이미지를 빌드하여 Amazon ECR에 푸시하는 경우 또는 소스 코드에 단위 테스트만 실행하고 빌드는 하지 않는 경우 등에는 이 시퀀스가 필요하지 않습니다.
참고
Amazon S3 메타데이터에는 Amazon S3에 아티팩트를 게시하는 CodeBuild 빌드의 buildArn
이 포함된 x-amz-meta-codebuild-buildarn
라는 CodeBuild 헤더가 있습니다. 알림에 대한 소스 추적을 허용하고 아티팩트가 생성된 빌드를 참조할 수 있도록 하기 위해 buildArn
이 추가되었습니다.
- 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를 사용하여 빌드를 생성하면 프로젝트가 업데이트되거나 생성되거나 빌드가 시작될 때
ProjectArtifacts
객체에overrideArtifactName
플래그가 설정됩니다. -
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가 빌드 출력 아티팩트에 포함할 파일 및 하위 디렉터리를 결정하는 데 사용하는 원래 빌드 위치에 상대적인 하나 이상의 최상위 디렉터리를 나타냅니다. 유효한 값으로는 다음이 포함됩니다.
-
단일 최상위 디렉터리입니다(예:
my-directory
). -
'my-directory*'
는 이름이my-directory
로 시작하는 모든 최상위 디렉터리를 나타냅니다.
빌드 출력 결과물에는 이 최상위 디렉터리가 포함되지 않으며, 파일 및 하위 디렉터리만 포함됩니다.
포함할 파일 및 하위 디렉터리를 보다 더 제한하려면
files
및discard-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
-
- artifacts/exclude-paths
-
선택적 매핑. CodeBuild가 빌드 아티팩트에서 제외할
base-directory
에 상대적인 하나 이상의 경로를 나타냅니다. 별표(*
) 문자는 폴더의 경계를 넘지 않고 0개 이상의 이름 구성 요소 문자와 해당합니다. 이중 별표(**
)는 모든 디렉터리에서 이름 구성 요소의 0개 이상 문자와 일치합니다.exclude-paths의 예는 다음과 같습니다.
-
모든 디렉터리에서 파일을 제외하려면:
"**/
file-name
/**/*" -
모든 dot 폴더를 제외하려면:
"**/.*/**/*"
-
모든 dot 파일을 제외하려면:
"**/.*"
-
- artifacts/enable-symlinks
-
선택 사항입니다. 출력 유형이
ZIP
인 경우 내부 심볼 링크를 ZIP 파일에 보존할지 여부를 지정합니다. 이 파일에yes
가 포함된 경우 소스의 모든 내부 심볼 링크가 아티팩트 ZIP 파일에 보존됩니다. - artifacts/s3-prefix
-
선택 사항입니다. 아티팩트가 Amazon S3 버킷으로 출력되고 네임스페이스 유형이
BUILD_ID
일 때 사용되는 접두사를 지정합니다. 사용될 경우 버킷의 출력 경로는<s3-prefix>/<build-id>/<name>.zip
입니다. - artifacts/secondary-artifacts
-
선택적 시퀀스. 1개 이상의 아티팩트 정의를 아티팩트 식별자와 아티팩트 정의를 연결하는 매핑으로 나타냅니다. 이 블록에서는 각 아티팩트가 프로젝트의
secondaryArtifacts
속성에서 정의하는 아티팩트와 일치해야 합니다. 각 정의는 위의artifacts
블록과 동일한 구문을 갖습니다.참고
2차 아티팩트만 정의된 경우에도 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 CLI 또는 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/**/*'"
다음은 CodeBuild 또는 CodePipeline 콘솔과 함께 사용하기 위한 build
단계의 명령 예입니다.
echo Build started on `date` && mvn install
아래 예에서
-
JAVA_HOME
의 키 및/usr/lib/jvm/java-8-openjdk-amd64
의 값이 있는 일반 텍스트의 사용자 지정 환경 변수가 설정됩니다. -
Amazon EC2 Systems Manager Parameter Store에 저장된
dockerLoginPassword
라는 사용자 지정 환경 변수는 나중에LOGIN_PASSWORD
키를 사용하여 빌드 명령에서 참조됩니다. -
이러한 빌드 단계 이름은 변경할 수 없습니다. 이 예에서 실행될 명령은
apt-get update -y
및apt-get install -y maven
(Apache Maven을 설치하는 데 사용),mvn install
(소스 코드를 빌드 출력 아티팩트로 컴파일, 테스트 및 패키징하고 빌드 출력 아티팩트를 내부 리포지토리에 설치하는 데 사용),docker login
(Amazon EC2 Systems Manager Parameter Store에 설정한 사용자 지정 환경 변수dockerLoginPassword
의 값에 해당하는 암호로 Docker에 로그인하는 데 사용) 및 여러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 |
|
0.1 | 이는 빌드 사양 형식의 초기 정의입니다. |