GitHub에서 저장소 빌드

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.

GitHub 트리거를 사용하면 Git push 및 pull 요청에 따라 자동으로 빌드하고 GitHub와 Google Cloud 콘솔에서 빌드 결과를 확인할 수 있습니다. 또한 GitHub 트리거는 기존 GitHub 트리거에서 지원되는 모든 기능을 지원하고, Cloud Build GitHub 앱을 사용하여 GitHub를 구성하고 인증합니다.

이 페이지에서는 Cloud Build GitHub 앱을 사용하여 GitHub 트리거를 만들고 GitHub에서 빌드하는 방법을 설명합니다.

시작하기 전에

  • Cloud Build API 사용 설정

    API 사용 설정

GitHub 트리거 만들기

Console

Google Cloud Console을 사용하여 GitHub 트리거를 만들려면 다음 안내를 따르세요.

  1. Google Cloud Console에서 트리거 페이지를 엽니다.

    트리거 페이지 열기

  2. 페이지 상단의 프로젝트 선택기 드롭다운 메뉴에서 프로젝트를 선택합니다.

  3. 열기를 클릭합니다.

  4. 트리거 만들기를 클릭합니다.

  5. 다음 트리거 설정을 입력합니다.

    • 이름: 트리거 이름을 입력합니다.

    • 리전: 트리거의 리전을 선택합니다.

      • 리전으로 전역을 선택하면 Cloud Build에서 기본 풀을 사용하여 빌드를 실행합니다.
      • 전역이 아닌 리전을 선택하고 트리거와 연결된 빌드 구성 파일에서 비공개 풀을 지정하면 Cloud Build가 비공개 풀을 사용하여 빌드를 실행합니다. 이 경우 트리거에 지정하는 리전은 비공개 풀을 만든 리전과 일치해야 합니다.
      • 전역이 아닌 리전을 선택하고 트리거와 연결된 빌드 구성 파일에서 비공개 풀을 지정하지 않으면 Cloud Build가 기본 풀을 사용하여 트리거와 동일한 리전에서 빌드를 실행합니다.
    • 설명(선택사항): 트리거에 대한 설명을 입력합니다.

    • 이벤트: 트리거를 호출할 저장소 이벤트를 선택합니다.

      • 분기로 푸시: 특정 분기에 대한 커밋에서 빌드를 시작하도록 트리거를 설정합니다.

      • 새 태그 푸시: 특정 태그가 포함된 커밋에서 빌드를 시작하도록 트리거를 설정합니다.

      • pull 요청(Cloud Source Repositories 지원되지 않음): pull 요청에 대한 커밋에서 빌드를 시작하도록 트리거를 설정합니다.

    • 소스: 이벤트를 감시할 저장소와 해당 분기 또는 태그를 선택합니다.

      • 저장소: 사용 가능한 저장소 목록에서 원하는 저장소를 선택합니다. 새 저장소를 연결하려면 추가 저장소 연결을 참조하세요.

      • 분기 또는 태그: 일치시킬 분기 또는 태그 값으로 정규 표현식을 지정합니다. 허용되는 정규 표현식 구문에 대한 자세한 내용은 RE2 구문을 참조하세요.

      • 댓글 제어: Pull 요청(GitHub 앱 전용)이벤트로 선택한 경우 다음 옵션 중 하나를 선택하여 트리거로 빌드를 자동으로 실행할지 여부를 제어합니다.

        • 소유자 및 공동작업자를 제외하고 필수: 저장소 소유자 또는 공동작업자가 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 서비스 계정이 사용됩니다.

  6. 만들기를 클릭하여 빌드 트리거를 저장합니다.

gcloud 명령어를 사용하여 GitHub 트리거를 만들려면 빌드 트리거 만들기gcloud 명령어를 참조하세요.

gcloud

gcloud 명령어를 사용하여 GitHub 트리거를 만들려면 다음 명령어를 실행합니다.

gcloud beta builds triggers create github \
    --repo-name=REPO_NAME \
    --repo-owner=REPO_OWNER \
    --branch-pattern=BRANCH_PATTERN \ # or --tag-pattern=TAG_PATTERN
    --build-config=BUILD_CONFIG_FILE \
    --include-logs-with-status

각 항목의 의미는 다음과 같습니다.

  • REPO_NAME은 저장소 이름입니다.
  • REPO_OWNER은 저장소 소유자의 사용자 이름입니다.
  • BRANCH_PATTERN은 빌드를 호출할 저장소의 분기 이름입니다.
  • TAG_PATTERN은 빌드를 호출할 저장소의 태그 이름입니다.
  • BUILD_CONFIG_FILE은 빌드 구성 파일의 경로입니다.
  • [선택사항] --include-logs-with-status는 저장소의 빌드 로그를 표시하도록 지정할 수 있는 플래그입니다. 이 플래그는 GitHub 및 GitHub Enterprise 저장소의 빌드에 지원됩니다. 빌드 로그를 보는 방법은 빌드 로그 보기를 참조하세요.

변경사항 빌드 및 보기

GitHub 트리거를 사용하여 빌드하려면 연결된 소스 저장소에 변경사항을 푸시 및 커밋하거나 pull 요청에 따라 빌드를 구성해야 합니다. 변경사항을 확인하면 Cloud Build가 코드를 빌드합니다.

GitHub에서 빌드 변경사항을 보려면 저장소의 확인 탭으로 이동합니다.

대화 탭의 스크린샷

Cloud Build가 변경사항을 빌드했음을 알 수 있습니다. 또한 코드를 빌드하는 데 걸린 시간, 빌드 ID와 같은 다른 빌드 세부정보가 표시됩니다.

Cloud Build에서 빌드 변경사항을 보려면 Google Cloud Build에 관한 추가적인 세부정보 보기를 클릭합니다. Google Cloud Console에서 상태, 로그, 빌드 단계와 같은 빌드 정보를 볼 수 있는 빌드 세부정보 페이지가 열립니다.

GitHub 기반 트리거의 서로 다른 유형

소스 코드가 GitHub에 있는 경우 Cloud Build는 빌드를 자동으로 실행하는 두 가지 방법을 제공합니다. 이 섹션에서는 두 가지 GitHub 기반 트리거를 설명하고 각각의 기능을 비교합니다.

  • GitHub 기존 트리거: GitHub 기존 트리거를 만들면 Cloud Build가 GitHub 저장소를 Cloud Source Repositories에 미러링하고 모든 작업에 미러링된 저장소를 사용합니다. Google Cloud Console을 사용하여 GitHub 트리거를 만들고 관리할 수 있습니다.

  • GitHub 트리거: 이 트리거 유형에서는 Cloud Build GitHub 앱을 사용하여 GitHub을 구성 및 인증합니다. GitHub 트리거를 사용하면 Git push 및 pull 요청에 따라 자동으로 빌드를 시작하고 GitHub와 Google Cloud Console에서 빌드 결과를 확인할 수 있습니다. 이 페이지에 설명된 대로 Google Cloud Console 또는 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 Console을 사용하여 트리거 만들기
Cloud Build API로 트리거 만들기 아니요
Cloud Build GitHub 앱으로 트리거 만들기 아니요
Google Cloud Console에서 빌드 상태 보기
GitHub에서 빌드 상태 보기 아니요

데이터 공유

GitHub 트리거가 Cloud Build GitHub 앱으로 데이터를 전송합니다. 앱으로 전송된 데이터를 통해 GitHub에서 이름으로 트리거를 식별하고 빌드 결과를 확인할 수 있습니다.

현재 Google Cloud와 GitHub 앱 간에 공유되는 데이터는 다음과 같습니다.

  • Cloud 프로젝트 ID
  • 트리거 이름
  • 빌드 로그

2020년 8월 이전에 트리거를 생성한 경우 프로젝트에 데이터 공유가 사용 설정되지 않았을 수 있습니다. Cloud Build 데이터 공유 탭에서 사용 설정을 클릭하여 프로젝트의 모든 GitHub 트리거에 데이터 공유를 사용 설정할 수 있습니다.

GitHub 저장소에 필수 상태 확인이 사용 설정된 경우 데이터 공유를 사용 설정하면 상태 확인이 일시적으로 중단될 수 있습니다. 다음과 같이 상태 확인 구성을 조정하여 트리거 이름을 찾을 수 있습니다.

  • GitHub 저장소에서 Cloud Build 관련 필수 확인 사용 중지
  • Cloud Build에서 데이터 공유가 사용 설정되어 있는지 확인
  • Cloud Build에서 저장소에 상태를 게시하는 새 빌드 실행
  • 트리거 이름을 선택하여 필수 상태 확인을 다시 사용 설정

다음 단계