빌드 프로젝트 생성(AWS CLI)

with 사용에 대한 자세한 내용은 CodeBuild 를 참조하십시오명령줄 참조. AWS CLI

를 사용하여 CodeBuild 빌드 프로젝트를 만들려면 JSON 형식의 프로젝트 구조를 만들고 구조를 채운 create-project다음 명령을 호출하여 프로젝트를 생성합니다. AWS CLI

JSON 파일 생성

--generate-cli-skeleton 옵션을 사용하여 create-project 명령으로 스켈레톤 JSON 파일을 생성합니다.


aws codebuild create-project --generate-cli-skeleton > <json-file>

이렇게 하면 <json-file>로 지정된 경로와 파일 이름을 가진 JSON 파일이 생성됩니다.

JSON 파일 채우기

JSON 데이터를 다음과 같이 수정하고 결과를 저장합니다.


{
  "name": "<project-name>",
  "description": "<description>",
  "source": {
    "type": "CODECOMMIT" | "CODEPIPELINE" | "GITHUB" | "GITHUB_ENTERPRISE" | "GITLAB" | "GITLAB_SELF_MANAGED" | "BITBUCKET" | "S3" | "NO_SOURCE",
    "location": "<source-location>",
    "gitCloneDepth": "<git-clone-depth>",
    "buildspec": "<buildspec>",
    "InsecureSsl": "<insecure-ssl>",
    "reportBuildStatus": "<report-build-status>",
    "buildStatusConfig": {
      "context": "<context>",
      "targetUrl": "<target-url>"
    },
    "gitSubmodulesConfig": {
      "fetchSubmodules": "<fetch-submodules>"
    },
    "auth": {
      "type": "<auth-type>",
      "resource": "<auth-resource>"
    },
    "sourceIdentifier": "<source-identifier>"
  },
  "secondarySources": [
    {
        "type": "CODECOMMIT" | "CODEPIPELINE" | "GITHUB" | "GITHUB_ENTERPRISE" | "GITLAB" | "GITLAB_SELF_MANAGED" | "BITBUCKET" | "S3" | "NO_SOURCE",
        "location": "<source-location>",
        "gitCloneDepth": "<git-clone-depth>",
        "buildspec": "<buildspec>",
        "InsecureSsl": "<insecure-ssl>",
        "reportBuildStatus": "<report-build-status>",
        "auth": {
          "type": "<auth-type>",
          "resource": "<auth-resource>"
        },
        "sourceIdentifier": "<source-identifier>"
    }
  ],
  "secondarySourceVersions": [
    {
      "sourceIdentifier": "<secondary-source-identifier>",
      "sourceVersion": "<secondary-source-version>"
    }
  ],
  "sourceVersion": "<source-version>",
  "artifacts": {
    "type": "CODEPIPELINE" | "S3" | "NO_ARTIFACTS",
    "location": "<artifacts-location>",
    "path": "<artifacts-path>",
    "namespaceType": "<artifacts-namespacetype>",
    "name": "<artifacts-name>",
    "overrideArtifactName": "<override-artifact-name>",
    "packaging": "<artifacts-packaging>"
  },
  "secondaryArtifacts": [
    {
      "type": "CODEPIPELINE" | "S3" | "NO_ARTIFACTS",
      "location": "<secondary-artifact-location>",
      "path": "<secondary-artifact-path>",
      "namespaceType": "<secondary-artifact-namespaceType>",
      "name": "<secondary-artifact-name>",
      "packaging": "<secondary-artifact-packaging>",
      "artifactIdentifier": "<secondary-artifact-identifier>"
    }
  ],
  "cache": {
    "type": "<cache-type>",
    "location": "<cache-location>",
    "mode": [
      "<cache-mode>"
    ]
  },
  "environment": {
    "type": "LINUX_CONTAINER" | "LINUX_GPU_CONTAINER" | "ARM_CONTAINER" | "WINDOWS_SERVER_2019_CONTAINER" | "WINDOWS_SERVER_2022_CONTAINER",
    "image": "<image>",
    "computeType": "BUILD_GENERAL1_SMALL" | "BUILD_GENERAL1_MEDIUM" | "BUILD_GENERAL1_LARGE" | "BUILD_GENERAL1_2XLARGE",
    "certificate": "<certificate>",
    "environmentVariables": [
      {
        "name": "<environmentVariable-name>",
        "value": "<environmentVariable-value>",
        "type": "<environmentVariable-type>"
      }
    ],
    "registryCredential": [
      {
        "credential": "<credential-arn-or-name>",
        "credentialProvider": "<credential-provider>"
      }
    ],
    "imagePullCredentialsType": "CODEBUILD" | "SERVICE_ROLE",
    "privilegedMode": "<privileged-mode>"
  },
  "serviceRole": "<service-role>",
  "timeoutInMinutes": <timeout>,
  "queuedTimeoutInMinutes": <queued-timeout>,
  "encryptionKey": "<encryption-key>",
  "tags": [
    {
      "key": "<tag-key>",
      "value": "<tag-value>"
    }
  ],
  "vpcConfig": {
    "securityGroupIds": [
         "<security-group-id>"
    ],
    "subnets": [
         "<subnet-id>"
    ],
    "vpcId": "<vpc-id>"
  },
  "badgeEnabled": "<badge-enabled>",
  "logsConfig": {
    "cloudWatchLogs": {
      "status": "<cloudwatch-logs-status>",
      "groupName": "<group-name>",
      "streamName": "<stream-name>"
    },
    "s3Logs": {
      "status": "<s3-logs-status>",
      "location": "<s3-logs-location>",
      "encryptionDisabled": "<s3-logs-encryption-disabled>"
    }
  },
  "fileSystemLocations": [
    {
      "type": "EFS",
      "location": "<EFS-DNS-name-1>:/<directory-path>",
      "mountPoint": "<mount-point>",
      "identifier": "<efs-identifier>",
      "mountOptions": "<efs-mount-options>"
    }
  ],
  "buildBatchConfig": {
    "serviceRole": "<batch-service-role>",
    "combineArtifacts": <combine-artifacts>,
    "restrictions": {
      "maximumBuildsAllowed": <max-builds>,
      "computeTypesAllowed": [
        "<compute-type>"
      ]
    },
    "timeoutInMins": <batch-timeout>,
    "batchReportMode": "REPORT_AGGREGATED_BATCH" | "REPORT_INDIVIDUAL_BUILDS"
  },
  "concurrentBuildLimit": <concurrent-build-limit>
}

다음을 바꿉니다.

이름

필수 사항입니다. 이 빌드 프로젝트의 이름입니다. 이 이름은 계정의 모든 빌드 프로젝트에서 고유해야 합니다. AWS

description

선택 사항입니다. 이 빌드 프로젝트의 설명입니다.

source

필수 사항입니다. 이 빌드 프로젝트의 소스 코드 설정에 대한 정보가 들어 있는 ProjectSource객체입니다. source 객체를 추가한 후에는 secondarySources를 사용해 소스를 최대 12개까지 더 추가할 수 있습니다. 이러한 설정에는 다음이 포함됩니다.

source/type

필수 사항입니다. 빌드할 소스 코드가 포함된 리포지토리의 유형입니다. 유효한 값으로는 다음이 포함됩니다.

CODECOMMIT
CODEPIPELINE
GITHUB
GITHUB_ENTERPRISE
GITLAB
GITLAB_SELF_MANAGED
BITBUCKET
S3
NO_SOURCE

NO_SOURCE를 사용할 경우 프로젝트에 소스가 없으므로 buildspec은 파일이 될 수 없습니다. 대신에 buildspec 속성을 사용하여 buildspec에 대해 YAML 형식이 지정된 문자열을 지정해야 합니다. 자세한 정보는 소스 샘플이 없는 프로젝트을 참조하세요.

source/location

<source-type>을 CODEPIPELINE으로 설정하지 않은 경우 필수입니다. 지정한 리포지토리 유형의 소스 코드 위치입니다.

소스 코드와 buildspec 파일이 들어 있는 저장소의 HTTPS 복제 URL (예:) 의 경우 CodeCommit https://git-codecommit.<region-id>.amazonaws.com/v1/repos/<repo-name>
Amazon S3의 경우 빌드 입력 버킷 이름 다음에 소스 코드 및 buildspec이 포함된 ZIP 파일의 경로와 이름이 옵니다. 예:
- 입력 버킷의 루트에 있는 ZIP 파일의 경우: <bucket-name>/<object-name>.zip
- 입력 버킷의 하위 폴더에 있는 ZIP 파일의 경우: <bucket-name>/<subfoler-path>/<object-name>.zip
소스 코드와 빌드스펙 파일이 들어 있는 저장소의 HTTPS 복제 URL의 경우 GitHub URL에 github.com이 포함되어야 합니다. AWS 계정을 계정에 연결해야 합니다. GitHub 이렇게 하려면 CodeBuild 콘솔을 사용하여 빌드 프로젝트를 만드세요.
- [Authorize application]을 선택합니다. ( GitHub 계정에 연결한 후에는 빌드 프로젝트 생성을 완료할 필요가 없습니다. CodeBuild 콘솔을 닫을 수 있습니다.
GitHub 엔터프라이즈 서버의 경우 소스 코드와 buildspec 파일이 들어 있는 저장소의 HTTP 또는 HTTPS 복제 URL입니다. 또한 계정을 엔터프라이즈 서버 AWS 계정에 연결해야 합니다 GitHub. 이렇게 하려면 CodeBuild 콘솔을 사용하여 빌드 프로젝트를 만드십시오.
1. GitHub 엔터프라이즈 서버에서 개인용 액세스 토큰을 생성합니다.
2. 이 토큰을 클립보드에 복사하면 프로젝트를 만들 때 사용할 수 있습니다 CodeBuild . 자세한 내용은 GitHub 도움말 웹 사이트의 명령줄용 개인용 액세스 토큰 만들기를 참조하십시오.
3. 콘솔을 사용하여 CodeBuild 프로젝트를 만들 때는 소스에서 소스 공급자로 GitHub Enterprise를 선택합니다.
4. [Personal Access Token]에서 클리보드에 복사한 토큰을 붙여 넣습니다. 토큰 저장을 선택합니다. 이제 CodeBuild 계정이 GitHub 엔터프라이즈 서버 계정에 연결되었습니다.
소스 코드와 buildspec 파일이 들어 있는 저장소의 HTTPS 복제 URL은 GitLab 자체 관리됩니다. GitLab 를 사용하는 경우 URL에 gitlab.com이 포함되어야 GitLab 한다는 점에 유의하세요. GitLab 자체 관리형을 사용하는 경우 URL에 gitlab.com이 포함되지 않아도 됩니다. AWS 계정을 본인 계정 또는 자체 관리 계정에 연결해야 합니다 GitLab. GitLab 이렇게 하려면 CodeBuild 콘솔을 사용하여 빌드 프로젝트를 만드세요.
- 개발자 도구 탐색 창에서 설정, 연결, 연결 생성을 선택합니다. 이 페이지에서 연결 GitLab 또는 GitLab 자체 관리형 연결을 만든 다음 Connect to GitLab (연결 대상) 를 선택합니다.
Bitbucket의 경우 HTTPS가 소스 코드 및 buildspec 파일을 포함하는 리포지토리에 URL을 복제합니다. URL에 bitbucket.org가 포함되어야 합니다. 또한 계정을 Bitbucket AWS 계정에 연결해야 합니다. 이렇게 하려면 CodeBuild 콘솔을 사용하여 빌드 프로젝트를 만드세요.
1. 콘솔을 사용하여 Bitbucket에 연결(또는 재연결)하면 Bitbucket [Confirm access to your account] 페이지에서 [Grant access]를 선택합니다. (Bitbucket 계정에 연결한 후에는 빌드 프로젝트 생성을 완료할 필요가 없습니다. CodeBuild 콘솔을 닫을 수 있습니다.
의 AWS CodePipeline경우 location 값을 지정하지 마십시오source. CodePipeline 에서 CodePipeline 파이프라인을 생성할 때 파이프라인의 소스 단계에서 소스 코드 위치를 지정하므로 이 값을 무시합니다.

소스/ gitCloneDepth

선택 사항입니다. 다운로드할 이력의 수준입니다. 최소값은 0입니다. 이 값이 0이거나, 25를 초과하거나, 지정되지 않은 경우 각 빌드 프로젝트에서 전체 이력이 다운로드됩니다. 소스 유형이 Amazon S3일 경우 이 값이 지원되지 않습니다.

source/buildspec

선택 사항입니다. 사용할 빌드 사양 정의 또는 파일입니다. 이 값을 제공하지 않거나 빈 문자열로 설정하는 경우 소스 코드에 루트 디렉터리의 buildspec.yml 파일이 포함되어 있어야 합니다. 이 값이 설정된 경우 인라인 buildspec 정의, 기본 소스의 루트 디렉터리에 상대적인 대체 buildspec 파일의 경로 또는 S3 버킷의 경로가 될 수 있습니다. 버킷은 빌드 프로젝트와 동일한 AWS 리전에 있어야 합니다. ARN을 사용하여 buildspec 파일을 지정합니다(예: arn:aws:s3:::<my-codebuild-sample2>/buildspec.yml). 자세한 정보는 buildspec 파일 이름 및 스토리지 위치을 참조하세요.

source/auth

사용하지 않습니다. 이 객체는 CodeBuild 콘솔에서만 사용됩니다.

소스/ reportBuildStatus

빌드의 시작 및 완료 상태를 소스 공급자에게 보낼지 여부를 지정합니다. GitHub 엔터프라이즈 서버 또는 Bitbucket이 아닌 GitHub 다른 소스 공급자로 이 값을 설정하면 invalidInputException an이 발생합니다.

소스 공급자에게 빌드 상태를 보고하려면 소스 공급자와 연결된 사용자에게 리포지토리에 대한 쓰기 권한이 있어야 합니다. 사용자에게 쓰기 권한이 없는 경우 빌드 상태를 업데이트할 수 없습니다. 자세한 정보는 소스 공급자 액세스을 참조하세요.

소스/ buildStatusConfig

CodeBuild 빌드 프로젝트가 빌드 상태를 소스 공급자에게 보고하는 방법을 정의하는 정보가 들어 있습니다. 이 옵션은 소스 유형이 GITHUB, GITHUB_ENTERPRISE 또는 BITBUCKET인 경우에만 사용됩니다.

소스//컨텍스트 buildStatusConfig

Bitbucket 소스의 경우 이 파라미터는 Bitbucket 커밋 상태의 name 파라미터에 사용됩니다. GitHub 소스의 경우 이 매개변수는 GitHub 커밋 상태의 context 매개변수에 사용됩니다.

예를 들어, CodeBuild 환경 변수를 사용하여 빌드 번호와 웹후크 트리거를 context 포함할 수 있습니다.


AWS CodeBuild sample-project Build #$CODEBUILD_BUILD_NUMBER - $CODEBUILD_WEBHOOK_TRIGGER

그 결과 webhook 풀 요청 이벤트에 의해 트리거된 빌드 #24에 대해 다음과 같은 컨텍스트가 나타납니다.


AWS CodeBuild sample-project Build #24 - pr/8

소스//타겟 URL buildStatusConfig

Bitbucket 소스의 경우 이 파라미터는 Bitbucket 커밋 상태의 url 파라미터에 사용됩니다. GitHub 소스의 경우 이 매개변수는 커밋 상태의 target_url 매개변수에 사용됩니다. GitHub

예를 들어 targetUrl를 https://aws.amazon.com/codebuild/<path to build>로 설정하면 커밋 상태가 이 URL에 연결됩니다.

URL에 추가 정보를 targetUrl 추가하기 위해 에 CodeBuild 환경 변수를 포함할 수도 있습니다. 예를 들어 URL에 빌드 리전을 영역을 추가하려면 다음과 같이 targetUrl을 설정합니다.


"targetUrl": "https://aws.amazon.com/codebuild/<path to build>?region=$AWS_REGION"

빌드 리전이 us-east-2이면 다음과 같이 확장됩니다.


https://aws.amazon.com/codebuild/<path to build>?region=us-east-2

소스/ gitSubmodulesConfig

선택 사항입니다. Git 하위 모듈 구성에 대한 정보입니다. CodeCommit, GitHub, GitHub 엔터프라이즈 서버 및 비트버킷에만 사용됩니다.

소스/ gitSubmodulesConfig 페치 서브 모듈: 리포지토리에 Git 하위 모듈을 포함하려면 fetchSubmodules를 true로 설정합니다. 포함된 Git 하위 모듈은 HTTPS로 구성해야 합니다.

소스/ InsecureSsl

선택 사항입니다. GitHub 엔터프라이즈 서버에만 사용됩니다. GitHub Enterprise Server 프로젝트 리포지토리에 연결하는 동안 TLS 경고를 true 무시하려면 이 값을 로 설정하십시오. 기본값은 false입니다. InsecureSsl은 테스트 용도로만 사용해야 합니다. 프로덕션 환경에 사용하면 안 됩니다.

source/sourceIdentifier

프로젝트 소스의 사용자 정의 식별자입니다. 기본 소스의 경우 선택 사항입니다. 보조 소스에 필요합니다.

secondarySources

선택 사항입니다. 빌드 프로젝트의 보조 소스에 대한 정보가 포함된 ProjectSource개체 배열입니다. 보조 소스는 12개까지 추가할 수 있습니다. secondarySources 객체는 source 객체에서 사용하는 것과 동일한 속성을 사용합니다. 보조 소스 객체에는 sourceIdentifier가 필요합니다.

secondarySourceVersions

선택 사항입니다. ProjectSourceVersion 객체 어레이. 빌드 레벨에서 secondarySourceVersions이 지정되어 있으면 그 버전이 이 버전보다 우선합니다.

sourceVersion

선택 사항입니다. 이 프로젝트에 대해 빌드할 빌드 입력의 버전입니다. 지정하지 않으면 최신 버전이 사용됩니다. 지정하면 다음 중 하나여야 합니다.

For CodeCommit, 사용할 커밋 ID, 브랜치 또는 Git 태그
F의 경우 GitHub, 빌드하려는 소스 코드의 버전에 해당하는 커밋 ID, 풀 리퀘스트 ID, 브랜치 이름 또는 태그 이름. 풀 요청 ID가 지정된 경우 pr/pull-request-ID 형식을 사용해야 합니다(예: pr/25). 분기 이름이 지정되어 있으면 분기의 HEAD 커밋 ID가 사용됩니다. 지정되지 않은 경우 기본 분기의 HEAD 커밋 ID가 사용됩니다.
커밋 ID GitLab, 풀 리퀘스트 ID, 브랜치 이름, 태그 이름 또는 참조 및 커밋 ID의 경우 자세한 정보는 소스 버전 샘플은 다음과 같습니다. AWS CodeBuild을 참조하세요.
Bitbucket의 경우, 빌드하려는 소스 코드의 버전에 해당하는 커밋 ID, 분기 이름 또는 태그 이름입니다. 분기 이름이 지정되어 있으면 분기의 HEAD 커밋 ID가 사용됩니다. 지정되지 않은 경우 기본 분기의 HEAD 커밋 ID가 사용됩니다.
Amazon S3의 경우 사용할 빌드 입력 ZIP 파일을 나타내는 객체의 버전 ID입니다.

빌드 수준에서 sourceVersion이 지정되어 있으면 (프로젝트 수준에서) 그 버전이 이 sourceVersion보다 우선합니다. 자세한 정보는 소스 버전 샘플은 다음과 같습니다. AWS CodeBuild을 참조하세요.

artifacts

필수 사항입니다. 이 빌드 프로젝트의 출력 아티팩트 설정에 대한 정보가 들어 있는 ProjectArtifacts객체입니다. artifacts 객체를 추가한 후에는 secondaryArtifacts를 사용해 아티팩트를 최대 12개까지 더 추가할 수 있습니다. 이러한 설정에는 다음이 포함됩니다.

artifacts/type

필수 사항입니다. 빌드 출력 결과물의 유형입니다. 유효한 값은 다음과 같습니다.

CODEPIPELINE
NO_ARTIFACTS
S3

artifacts/location