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로 인해 실행되지 않습니다.
  • 스케줄 또는 병합 요청에 대한 파이프라인도 실행되지 않으며, 이를 위해 true로 평가되는 규칙이 없습니다.
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

GitLab이 다음을 시도할 경우:

  • 병합 요청 파이프라인, 파이프라인 시작. 예를 들어, 병합 요청 파이프라인은 열려 있는 병합 요청과 연결된 브랜치에 푸시하여 트리거될 수 있습니다.
  • 브랜치 파이프라인, 그러나 해당 브랜치에 대한 병합 요청이 열려 있는 경우, 브랜치 파이프라인을 실행하지 않습니다. 예를 들어, 브랜치 파이프라인은 브랜치 변경, API 호출, 예약된 파이프라인 등으로 트리거될 수 있습니다.
  • 브랜치 파이프라인, 그러나 해당 브랜치에 대한 병합 요청이 열려 있지 않은 경우, 브랜치 파이프라인을 실행합니다.

병합 요청이 생성될 때 브랜치 파이프라인에서 병합 요청 파이프라인으로 전환하기 위해 기존의 workflow 섹션에 규칙을 추가할 수도 있습니다.

이 규칙을 workflow 섹션의 맨 위에 추가하고 기존에 있던 다른 규칙을 따릅니다:

workflow:  
  rules:  
    - if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS && $CI_PIPELINE_SOURCE == "push"  
      when: never  
    - ...                # 이전에 정의된 워크플로우 규칙 여기

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

Git Flow 및 Merge Request 파이프라인

workflow: rules를 사용하여 merge request 파이프라인을 사용할 수 있습니다. 이러한 규칙을 통해 기능 브랜치와 함께 merge request 파이프라인 기능을 사용할 수 있으며, 소프트웨어의 여러 버전을 지원하기 위해 장기 유지 브랜치를 유지할 수 있습니다.

예를 들어, merge request, 태그 및 보호된 브랜치에 대해서만 파이프라인을 실행하려면 다음과 같이 설정할 수 있습니다:

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

이 예시는 장기 유지 브랜치가 보호됨이라고 가정합니다.

초안 Merge Request의 파이프라인 건너뛰기

workflow: rules를 사용하여 초안 merge request의 파이프라인을 건너뛸 수 있습니다. 이러한 규칙을 사용하면 개발이 완료될 때까지 컴퓨트 분을 사용하지 않을 수 있습니다.

예를 들어, 아래의 규칙은 제목에 [Draft], (Draft), 또는 Draft:가 포함된 merge request에 대해 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 템플릿 (Deprecated)

경고:
workflow:rules 템플릿은 더 이상 사용되지 않음으로 GitLab 17.0에서 폐기되었으며, 18.0에서 제거될 예정입니다. 이 변경은 파괴적인 변경입니다.

파이프라인의 workflow:rules를 구성하려면, 키워드를 명시적으로 추가하세요. 옵션에 대한 예는 위를 참조하세요.

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

Branch-Pipelines 템플릿은 브랜치 및 태그에 대해 파이프라인을 실행합니다.

브랜치 파이프라인 상태는 브랜치를 소스로 사용하는 merge request에 표시됩니다. 그러나 이 파이프라인 유형은 merge request 파이프라인에서 제공하는 merged results 파이프라인 또는 merge trains와 같은 기능을 지원하지 않습니다. 이 템플릿은 의도적으로 이러한 기능을 피합니다.

포함하려면:

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

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

포함하려면:

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

문제 해결

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

병합 요청에 파이프라인 상태 확인 중. 메시지가 표시되지만 메시지가 사라지지 않는 경우(스피너가 멈추지 않음), workflow:rules 때문일 수 있습니다.

이 문제는 프로젝트에 파이프라인이 성공해야 함 기능이 활성화되어 있지만, workflow:rules가 병합 요청을 위해 파이프라인이 실행되는 것을 방지할 때 발생할 수 있습니다.

예를 들어, 이 워크플로우로 병합 요청은 병합될 수 없습니다. 왜냐하면 실행할 수 있는 파이프라인이 없기 때문입니다:

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