Cloud Build를 사용하면 GitHub에 호스팅된 저장소에서 빌드할 트리거를 만들 수 있습니다. GitHub 저장소와 연관된 커밋 푸시 또는 병합 요청과 같은 이벤트에 대한 응답으로 빌드를 실행할 수 있습니다.
이 페이지에서는 GitHub 인스턴스에 빌드 트리거를 사용 설정하는 방법을 설명합니다. 자세한 내용은 Cloud Build 트리거 및 Cloud Build 저장소를 참고하세요.
시작하기 전에
안내에 따라 GitHub 호스트에 연결합니다.-
Enable the Cloud Build API.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (
roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enablepermission. Learn how to grant roles.
GitHub 저장소의 트리거를 만들려면 Google Cloud 와 저장소 간에 연결이 있어야 합니다. Google Cloud의 GitHub 앱을 통해 연결을 만들려면 GitHub 저장소에 연결을 참고하세요.
GitHub 트리거 만들기
이 섹션에서는 트리거를 만들고 GitHub 설치에 연결하는 방법을 설명합니다.
Google Cloud 콘솔
Google Cloud 콘솔을 사용하여 GitHub 트리거를 만들려면 다음을 수행합니다.
Google Cloud 콘솔에서 트리거 페이지를 엽니다.
Google Cloud 프로젝트를 선택하고 열기를 클릭합니다.
트리거 만들기를 클릭합니다.
다음 트리거 설정을 입력합니다.
이름: 트리거 이름을 입력합니다.
리전: 트리거의 리전을 선택합니다.
* If the build config file associated with the trigger specifies a [private pool](/build/docs/private-pools/private-pools-overview), then Cloud Build uses the private pool to run your build. In this case, the region you specify in your trigger must match the region where you created your private pool. * If the build config file associated with the trigger **doesn't** specify a private pool, then Cloud Build uses the default pool to run your build in the same region as your trigger.설명(선택사항): 트리거에 대한 설명을 입력합니다.
이벤트: 트리거를 호출할 저장소 이벤트를 선택합니다.
브랜치로 푸시: 특정 브랜치 대한 커밋에서 빌드를 시작하도록 트리거를 설정합니다.
새 태그 푸시: 특정 태그가 포함된 커밋에서 빌드를 시작하도록 트리거를 설정합니다.
pull 요청: pull 요청에 대한 커밋에서 빌드를 시작하도록 트리거를 설정합니다.
소스: GitHub 저장소에 관한 정보를 구성합니다.
저장소 서비스: Cloud Build를 선택합니다.
저장소 생성: 1세대를 소스로 선택합니다.
저장소: 사용 가능한 저장소 목록에서 저장소를 선택합니다.
브랜치 또는 태그: 일치시킬 브랜치 또는 태그 값으로 정규 표현식을 지정합니다. 허용되는 정규 표현식 구문에 대한 자세한 내용은 RE2 구문을 참조하세요.
댓글 제어: Pull 요청을 이벤트로 선택한 경우 다음 옵션 중 하나를 선택하여 트리거로 빌드를 자동으로 실행할지 여부를 제어합니다.
소유자 및 공동작업자를 제외하고 필수: 저장소 소유자 또는 공동작업자가 pull 요청을 만들거나 업데이트하면 트리거로 빌드가 자동으로 실행됩니다. 외부 공동작업자가 작업을 시작하면 소유자 또는 공동작업자가 pull 요청에서
/gcbrun댓글을 작성한 후에만 빌드가 실행됩니다.필수: 공동작업자가 pull 요청을 만들거나 업데이트하면 소유자 또는 공동작업자가 pull 요청에 대해
/gcbrun댓글을 작성한 후에만 빌드가 실행됩니다. 빌드는 pull 요청이 변경될 때마다 실행됩니다.필수 아님: 공동작업자가 pull 요청을 만들거나 업데이트하면 트리거로 빌드가 자동으로 실행됩니다.
구성: 원격 저장소에 있는 빌드 구성 파일을 선택하거나 빌드에 사용할 인라인 빌드 구성 파일을 만듭니다.
- 유형: 빌드에 사용할 구성의 유형을 선택합니다.
- 자동 감지: 저장소에
cloudbuild.yaml또는Dockerfile이 있는 경우 Cloud Build가 구성 유형을 자동으로 감지합니다. - Cloud Build 구성 파일(yaml 또는 json): 구성에 대해 빌드 구성 파일을 사용합니다.
- Dockerfile: 해당 구성에
Dockerfile을 사용합니다. - 빌드팩: 구성에 빌드팩을 사용합니다.
- 자동 감지: 저장소에
위치: 구성의 위치를 지정합니다.
- 저장소: 구성 파일이 원격 저장소에 있으면 빌드 구성 파일의 위치나
Dockerfile디렉터리 및 결과 이미지 이름을 제공합니다. 구성이Dockerfile이면 선택적으로 빌드에 대해 제한 시간을 제공할 수 있습니다.Dockerfile과 이미지 이름을 제공하면, 빌드가 실행할docker build명령어의 미리보기가 표시됩니다. - 인라인: Cloud Build 구성 파일(yaml 또는 json)을 구성 옵션으로 선택한 경우 빌드 구성을 인라인으로 지정할 수 있습니다. YAML 또는 JSON 구문을 사용하여Google Cloud 콘솔에서 빌드 구성 파일을 작성하려면 편집기 열기를 클릭합니다. 빌드 구성을 저장하려면 완료를 클릭합니다.
- 저장소: 구성 파일이 원격 저장소에 있으면 빌드 구성 파일의 위치나
- 유형: 빌드에 사용할 구성의 유형을 선택합니다.
대체 변수(선택사항): Cloud Build 구성 파일을 빌드 구성 옵션으로 선택한 경우 이 필드를 사용하여 트리거별 대체 변수를 정의할 수 있습니다. 예를 들어 각 트리거가 앱을 특정 환경에 배포하는 트리거를 여러 개 만든다고 가정해 보겠습니다. 앱이 빌드 구성 파일의 한 환경에 배포되도록 지정한 후 이 필드를 사용하여 트리거가 배포할 환경을 지정하는 대체 변수를 정의할 수 있습니다. 빌드 구성 파일의 대체 값을 지정하는 방법은 대체 변수 값을 참조하세요.
빌드 로그(선택사항): GitHub에 빌드 로그를 전송하려면 체크박스를 선택합니다. 빌드 로그를 보는 방법은 빌드 로그 보기를 참조하세요.
서비스 계정: 트리거를 호출할 때 사용할 서비스 계정을 선택합니다. 조직 정책에서 기존 Cloud Build 서비스 계정 사용을 허용하는 경우 기존 서비스 계정을 사용하도록 이 필드를 비워 둘 수 있습니다. 그렇지 않으면 Compute Engine 기본 서비스 계정이라도 사용할 특정 서비스 계정을 선택해야 합니다.
만들기를 클릭하여 빌드 트리거를 저장합니다.
gcloud 명령어를 사용하여 GitHub 트리거를 만들려면 빌드 트리거 만들기의 gcloud 명령어를 참조하세요.
gcloud CLI
gcloud 명령어를 사용하여 GitHub 트리거를 만들려면 다음 명령어를 실행합니다.
gcloud alpha builds triggers create developer-connect
--name=TRIGGER_NAME \
--git-repository-link=projects/PROJECT_ID/locations/REGION/connections/CONNECTION_NAME/gitRepositoryLinks/REPO_NAME \
--branch-pattern=BRANCH_PATTERN # or --tag-pattern=TAG_PATTERN \
--build-config=BUILD_CONFIG_FILE \
--region=REGION \
--service-account=SERVICE-ACCOUNT
각 항목의 의미는 다음과 같습니다.
- TRIGGER_NAME은 트리거의 이름입니다.
- PROJECT_ID는 Google Cloud 프로젝트 ID입니다.
- REGION은 트리거의 리전입니다.
- CONNECTION_NAME: GitHub 연결의 이름입니다.
- GIT_REPOSITORY_LINK: Git 저장소 링크입니다.
- BRANCH_PATTERN은 빌드를 호출할 저장소의 브랜치 이름입니다.
- TAG_PATTERN: 빌드를 호출할 저장소의 태그 이름입니다.
- BUILD_CONFIG_FILE은 빌드 구성 파일의 경로입니다.
- SERVICE-ACCOUNT는 트리거 및 빌드 작업에 사용할 서비스 계정입니다.
API
API로 GitHub 트리거를 만들려면 다음 JSON 템플릿을 사용합니다.
{
"filename": "cloudbuild.yaml",
"name": "TRIGGER_NAME",
"description": "TRIGGER_DESCRIPTION",
"serviceAccount": "SERVICE_ACCOUNT",
"github": {
"owner": "OWNER",
"name": "REPO_NAME",
"push": {
"branch": ".*"
},
},
"include_build_logs": include-build-logs-value
}
각 항목의 의미는 다음과 같습니다.
- TRIGGER_NAME은 트리거의 이름입니다.
- TRIGGER_DESCRIPTION은 트리거에 대한 설명입니다.
- SERVICE_ACCOUNT는 트리거 및 빌드 작업에 사용할 서비스 계정입니다.
- OWNER는 GitHub 저장소 소유자입니다.
- REPO_NAME은 GitHub 저장소 이름입니다.
- include-build-logs-value은 선택사항인
include_build_logs필드의 값입니다. 이 필드의 값이INCLUDE_BUILD_LOGS_SPECIFIED이면 빌드 로그가 저장소에 표시됩니다.
터미널에 다음 curl 명령어를 입력합니다.
curl -X POST -H "Authorization: Bearer "$(gcloud auth print-access-token) -H "Content-Type: application/json; charset=utf-8" -H "x-goog-user-project: PROJECT_NUMBER" https://cloudbuild.googleapis.com/v1/projects/PROJECT_ID/triggers -d @trigger.json
각 항목의 의미는 다음과 같습니다.
- PROJECT_NUMBER는 Google Cloud 프로젝트 번호입니다.
- PROJECT_ID는 Google Cloud 프로젝트 ID입니다.
변경사항 빌드 및 보기
GitHub 트리거를 사용하여 빌드하려면 연결된 소스 저장소에 변경사항을 푸시 및 커밋하거나 pull 요청에 따라 빌드를 구성해야 합니다. 변경사항을 확인하면 Cloud Build가 코드를 빌드합니다.
GitHub에서 빌드 변경사항을 보려면 저장소의 확인 탭으로 이동합니다.
Cloud Build가 변경사항을 빌드했음을 알 수 있습니다. 또한 코드를 빌드하는 데 걸린 시간, 빌드 ID와 같은 다른 빌드 세부정보가 표시됩니다.
Cloud Build에서 빌드 변경사항을 보려면 Google Cloud Build에 대한 자세한 내용 보기를 클릭합니다. Google Cloud 콘솔에서 상태, 로그, 빌드 단계와 같은 빌드 정보를 볼 수 있는 빌드 세부정보 페이지가 열립니다.
GitHub 기반 트리거의 서로 다른 유형
소스 코드가 GitHub에 있는 경우 Cloud Build는 빌드를 자동으로 실행하는 두 가지 방법을 제공합니다. 이 섹션에서는 두 가지 GitHub 기반 트리거를 설명하고 각각의 기능을 비교합니다.
GitHub 기존 트리거: GitHub 기존 트리거를 만들면 Cloud Build가 GitHub 저장소를 Cloud Source Repositories에 미러링하고 모든 작업에 미러링된 저장소를 사용합니다. Google Cloud 콘솔을 사용하여 GitHub 트리거를 만들고 관리할 수 있습니다.
GitHub 트리거: 이 트리거 유형에서는 Cloud Build GitHub 앱을 사용하여 GitHub을 구성 및 인증합니다. GitHub 트리거를 사용하면 Git push 및 pull 요청에 따라 자동으로 빌드를 시작하고 GitHub와 Google Cloud 콘솔에서 빌드 결과를 확인할 수 있습니다. 이 페이지에 설명된 대로 Google Cloud 콘솔 또는 Cloud Build API를 사용하여 GitHub 트리거를 만들고 관리할 수 있습니다.
GitHub Enterprise 트리거: 이 유형의 트리거를 사용하면 GitHub Enterprise 인스턴스에서 커밋 또는 pull 요청에 대한 응답으로 빌드를 호출할 수 있습니다. Google Cloud 콘솔 또는 Cloud Build API를 사용하여 GitHub Enterprise에서 저장소를 빌드할 수 있습니다.
다음 표에서는 GitHub 기존 트리거, GitHub 트리거, GitHub Enterprise 트리거를 비교합니다.
| 기능 | GitHub 기존 트리거 | GitHub 트리거 | GitHub Enterprise 트리거 |
|---|---|---|---|
| 소스 코드 푸시에 따라 빌드 실행 | 예 | 예 | 예 |
| pull 요청에 따라 빌드 실행 | 아니요 | 예 | 예 |
| Google Cloud 콘솔을 사용하여 트리거 만들기 | 예 | 예 | 예 |
| Cloud Build API로 트리거 만들기 | 아니요 | 예 | 예 |
| Cloud Build GitHub 앱으로 트리거 만들기 | 아니요 | 예 | 예 |
| Google Cloud 콘솔에서 빌드 상태 보기 | 예 | 예 | 예 |
| GitHub에서 빌드 상태 보기 | 아니요 | 예 | 예 |
데이터 공유
Cloud Build에서 GitHub로 전송된 데이터를 사용하면 이름으로 트리거를 식별하고 GitHub에서 빌드 결과를 확인할 수 있습니다.
다음 데이터는 현재 Cloud Build와 GitHub 간에 공유됩니다.
- Cloud 프로젝트 ID
- 트리거 이름
- 빌드 로그
2020년 8월 이전에 트리거를 생성한 경우 프로젝트에 데이터 공유가 사용 설정되지 않았을 수 있습니다. Cloud Build 데이터 공유 탭에서 사용 설정을 클릭하여 프로젝트의 모든 GitHub 트리거에 데이터 공유를 사용 설정할 수 있습니다.
GitHub 저장소에 필수 상태 확인을 사용 설정한 경우 데이터 공유를 사용 설정하면 상태 확인이 일시적으로 중단될 수 있습니다. 다음과 같이 상태 확인 구성을 조정하여 트리거 이름을 찾을 수 있습니다.
- GitHub 저장소에서 Cloud Build 관련 필수 확인 사용 중지
- Cloud Build에서 데이터 공유가 사용 설정되어 있는지 확인
- Cloud Build에서 저장소에 상태를 게시하는 새 빌드 실행
- 트리거 이름을 선택하여 필수 상태 확인을 다시 사용 설정
다음 단계
- 빌드 트리거 만들기 및 관리 방법 알아보기
- Compute Engine에서 블루-그린 배포를 수행하는 방법을 알아봅니다.