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 브랜치 파이프라인이 실행되는 시점을 제어합니다.

더 많은 예제는 rules에 대한 일반 if 절을 참조하세요.

workflow:rules 예제

다음 예제에서:

  • 모든 push 이벤트(브랜치 변경 및 새 태그)에 대해 파이프라인이 실행됩니다.
  • -draft로 끝나는 커밋 메시지를 가진 push 이벤트의 파이프라인은 실행되지 않습니다. 왜냐하면 실행되지 않도록 설정되어 있기 때문입니다.
  • 스케줄 또는 합병 요청 파이프라인도 실행되지 않습니다. 왜냐하면 해당 사례에 대한 규칙이 참이 되지 않기 때문입니다. 
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
    - ...                # 여기에 이미 정의된 workflow 규칙들

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

Pipelines 트리거는 파이프라인 소스가 trigger 또는 pipeline이므로 && $CI_PIPELINE_SOURCE == "push"가 규칙이 트리거된 파이프라인을 차단하지 않습니다.

Git Flow with merge request pipelines

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

예를 들어, 병합 요청, 태그 및 보호된 브랜치에 대해서만 파이프라인을 실행하려면: 

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

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

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'

문제 해결

Checking pipeline status. 메시지로 인해 병합 요청이 멈춤

병합 요청에 Checking pipeline status.가 표시되지만 메시지가 사라지지 않을 때 (스피너가 계속 돌아가는 경우) workflow:rules 때문일 수 있습니다. 프로젝트에 파이프라인이 성공해야 함 기능이 활성화되어 있지만 workflow:rules로 인해 병합 요청에 대한 파이프라인이 실행되지 않을 수 있습니다.

예를 들어, 이러한 워크플로우에서는 어떤 파이프라인도 실행할 수 없으므로 병합 요청을 병합할 수 없습니다: 

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