GitLab CI/CD workflow 키워드

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

파이프라인이 생성되는 시점을 제어하려면 workflow 키워드를 사용합니다.

workflow 키워드는 작업 이전에 평가됩니다. 예를 들어, 작업이 태그를 위해 구성되었지만 workflow가 태그 파이프라인을 막는다면 해당 작업은 실행되지 않습니다.

workflow:rules에 대한 공통 if 절

workflow:rules의 몇 가지 예시 if 절:

예시 규칙 세부 정보
if: '$CI_PIPELINE_SOURCE == "merge_request_event"' 병합 요청 파이프라인을 실행하는 제어
if: '$CI_PIPELINE_SOURCE == "push"' 브랜치 파이프라인 및 태그 파이프라인을 실행하는 제어
if: $CI_COMMIT_TAG 태그 파이프라인을 실행하는 제어
if: $CI_COMMIT_BRANCH 브랜치 파이프라인을 실행하는 제어

더 많은 예시를 보려면 사전 정의된 변수를 통한 공통 if 절을 참고하세요.

workflow:rules 예시

다음 예시에서:

  • 모든 push 이벤트(브랜치에 대한 변경 및 새로운 태그)에 대해 파이프라인이 실행됩니다.
  • -draft로 끝나는 커밋 메시지를 가진 push 이벤트에 대한 파이프라인은 실행되지 않습니다. 이는 when: never로 설정되어 있기 때문입니다.
  • 스케줄이나 병합 요청의 파이프라인 역시 실행되지 않습니다. 해당 사례에 대해 참값을 평가하는 규칙이 없기 때문입니다. 
workflow:
  rules:
    - if: $CI_COMMIT_MESSAGE =~ /-draft$/
      when: never
    - if: $CI_PIPELINE_SOURCE == "push"

이 예시는 엄격한 규칙을 가지고 있으며, 파이프라인은 다른 경우에는 실행되지 않습니다.

또 다른 방법으로, 모든 규칙이 when: never일 수 있고, 마지막에 when: always 규칙을 추가할 수 있습니다. when: never 규칙에 맞는 파이프라인은 실행되지 않습니다. 다른 파이프라인 유형은 모두 실행됩니다. 예를 들어: 

workflow:
  rules:
    - if: $CI_PIPELINE_SOURCE == "schedule"
      when: never
    - if: $CI_PIPELINE_SOURCE == "push"
      when: never
    - when: always

이 예시는 스케줄 또는 push (브랜치 및 태그) 파이프라인을 막습니다. 마지막 when: always 규칙은 병합 요청 파이프라인을 포함한 다른 파이프라인 유형을 실행합니다.

브랜치 파이프라인 및 병합 요청 파이프라인 간 전환

병합 요청이 생성된 후에 파이프라인을 브랜치 파이프라인에서 병합 요청 파이프라인으로 전환하려면 .gitlab-ci.yml 파일에 workflow:rules 섹션을 추가하세요.

동시에 두 가지 파이프라인 유형을 사용하는 경우, 중복 파이프라인이 동시에 실행될 수 있습니다. 중복 파이프라인을 방지하려면 CI_OPEN_MERGE_REQUESTS 변수를 사용하세요.

다음 예시는 브랜치 및 병합 요청 파이프라인만 실행하지만 다른 케이스에 대해서는 파이프라인을 실행하지 않습니다. 다음과 같이 실행됩니다:

  • 병합 요청이 브랜치에 대해 열려 있지 않은 경우 브랜치 파이프라인이 실행됩니다.
  • 브랜치에 대해 병합 요청이 열려 있을 때 병합 요청 파이프라인이 실행됩니다. 
workflow:
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
    - if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS
      when: never
    - if: $CI_COMMIT_BRANCH

다음과 같이 규칙에 기존 workflow 섹션에 룰을 추가하여 브랜치 파이프라인에서 병합 요청 파이프라인으로 전환할 수 있습니다.

기존에 있던 다른 규칙들 뒤에 이 규칙을 추가하세요. 

workflow:
  rules:
    - if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS && $CI_PIPELINE_SOURCE == "push"
      when: never
    - ...

브랜치에 대한 파이프라인을 시작하려면:

  • 예를 들어 브랜치에 연결된 열린 병합 요청으로 인해 병합 요청 파이프라인을 시작하세요.
  • 브랜치에 대한 파이프라인이 시작되려고 하지만 해당 브랜치에 대해 병합 요청이 열려있으면 브랜치 파이프라인을 실행하지 마세요. 예를 들어 브랜치에 대한 파이프라인은 브랜치 변경, API 호출, 예약된 파이프라인 등에 의해 시작될 수 있습니다.
  • 브랜치에 대한 파이프라인이 시작되려고 하지만 해당 브랜치에 대해 열린 병합 요청이 없으면 브랜치 파이프라인을 실행하세요.

또한, 병합 요청이 생성된 후에 브랜치 파이프라인에서 병합 요청 파이프라인으로 전환할 수 있는 규칙을 기존 workflow 섹션에 추가할 수 있습니다. 

workflow:
  rules:
    - if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS && $CI_PIPELINE_SOURCE == "push"
      when: never
    - ...                # 이미 정의된 workflow 규칙을 여기에 추가

브랜치에서 실행되는 트리거된 파이프라인은 $CI_COMMIT_BRANCH가 설정되어 있으며 유사한 규칙으로 차단될 수 있습니다. 트리거된 파이프라인의 파이프라인 소스는 trigger 또는 pipeline이므로 && $CI_PIPELINE_SOURCE == "push"가 규칙이 트리거된 파이프라인을 차단하지 않도록 합니다.

병합 요청 파이프라인과 함께 Git Flow 사용

병합 요청 파이프라인과 함께 workflow:rules을 사용할 수 있습니다. 이러한 규칙을 사용하면 특징 브랜치에서 병합 요청 파이프라인 기능를 사용하면서 소프트웨어의 여러 버전을 지원하는 장기 브랜치를 유지할 수 있습니다.

예를 들어 병합 요청, 태그, 보호된 브랜치에 대해 파이프라인만 실행하려면 다음과 같이 할 수 있습니다: 

workflow:
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
    - if: $CI_COMMIT_TAG
    - if: $CI_COMMIT_REF_PROTECTED == "true"

이 예시는 장기 브랜치가 보호되어 있다고 가정합니다.

임시 병합 요청을 위한 파이프라인 건너뛰기

병합 요청에 대한 CI 빌드를 건너뛰기 위해 workflow:rules를 사용할 수 있습니다. 이러한 규칙을 사용하면 개발이 완료될 때까지 컴퓨팅 시간을 사용하지 않을 수 있습니다.

예를 들어, 다음 규칙을 사용하여 타이틀에 [Draft], (Draft), 또는 Draft:가 포함된 병합 요청에 대한 CI 빌드를 비활성화할 수 있습니다: 

workflow:
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_TITLE =~ /^(\[Draft\]|\(Draft\)|Draft:)/
      when: never

stages:
  - build

build-job:
  stage: build
  script:
    - echo "Testing"

workflow:rules 템플릿 (사용 중지됨)

경고: workflow:rules 템플릿은 GitLab 17.0에서 사용이 중지되었으며 18.0에서 삭제가 예정되어 있습니다. 이 변경 사항은 파괴적인 변경 사항입니다. 파이프라인에서 workflow:rules를 구성하려면 키워드를 명시적으로 추가하세요. 옵션에 대한 예는 위의 예제를 참조하세요.

GitLab은 일반적인 시나리오에 대한 workflow:rules를 설정하는 템플릿을 제공합니다. 이러한 템플릿은 중복된 파이프라인을 방지하는 데 도움이 됩니다.

Branch-Pipelines 템플릿은 브랜치 및 태그를 사용하여 파이프라인을 실행합니다.

브랜치 파이프라인 상태는 소스로 사용하는 브랜치를 이용하는 병합 요청에서 표시됩니다. 그러나 이 파이프라인 유형은 병합 요청 파이프라인에서 제공되는 기능을 지원하지 않습니다. 예를 들어 병합된 결과 파이프라인 또는 병합 트레인 같은 기능은 지원하지 않습니다. 이 템플릿은 이러한 기능을 의도적으로 피합니다.

포함하려면: 

include:
  - template: 'Workflows/Branch-Pipelines.gitlab-ci.yml'

MergeRequest-Pipelines 템플릿은 기본 브랜치, 태그 및 모든 종류의 병합 요청 파이프라인에 대해 파이프라인을 실행합니다. 이 템플릿은 병합 요청 파이프라인 기능을 사용하는 경우 사용하세요.

포함하려면: 

include:
  - template: 'Workflows/MergeRequest-Pipelines.gitlab-ci.yml'

문제 해결

병합 요청이 파이프라인 상태 확인 중. 메시지로 멈춰있는 경우

병합 요청이 파이프라인 상태 확인 중.으로 표시되지만 메시지가 사라지지 않는 경우(“스피너”가 계속 돌아가는 경우), 이는 workflow:rules으로 인한 것일 수 있습니다. 이 문제는 프로젝트가 파이프라인이 성공해야 함으로 설정되어 있지만, workflow:rules로 인해 병합 요청용 파이프라인이 실행되지 못하는 경우 발생할 수 있습니다.

예를 들어, 다음과 같은 워크플로우로 인해 병합 요청을 병합할 수 없게 됩니다. 왜냐하면 어떤 파이프라인도 실행되지 않기 때문입니다: 

workflow:
  rules:
    - changes:
        - .gitlab/**/**.md
      when: never