CI/CD 단계

Tier: Free, Premium, Ultimate Offering: GitLab.com, 자체 관리, GitLab Dedicated Status: Experimental

단계는 작업의 재사용 가능하고 합성 가능한 부분입니다. 각 단계는 다른 단계에서 소비할 수 있는 구조화된 입력과 출력을 정의합니다. 단계는 로컬 파일, GitLab.com 리포지토리 또는 다른 Git 소스에서 가져올 수 있습니다.

단계는 작업을 실행하는 데 쉘 스크립트 대안입니다. 더 많은 구조를 제공하며, 조합할 수 있고, 테스트하고 재사용할 수 있습니다. exec:command는 쉘을 실행하는 것이 아니라 Exec 시스템 호출을 사용하여 실행됩니다.

시작하려면 단계 설정 튜토리얼을 참조하십시오.

단계를 발행하는 CI 카탈로그 지원은 issue 425891에서 제안되었습니다.

단계 정의

단계는 step.yml 파일에 정의됩니다. 각 파일에는 사양과 정의 두 문서가 있습니다.

사양은 입력, 출력, 유형, 설명 및 기본값을 제공합니다.

# 사양 예
spec:
  inputs:
    name:
      type: string
      default: joe steppy
---
# (여기에 정의가 들어갑니다)

정의는 단계의 구현을 제공합니다. 두 가지 유형의 단계 정의가 있습니다. - exec 유형: 명령을 실행합니다.

  # (사양이 여기에 들어갑니다)
  ---
  # 실행 예시 정의
  exec:
    command: [ docker, run, -it, ubuntu, uname, -a ]

steps 유형: 다른 단계의 시퀀스를 실행합니다.

# (사양이 여기에 들어갑니다)
---
# 단계 예시 정의
steps:
  - name: greet_user
    step: gitlab.com/gitlab-org/ci-cd/runner-tools/echo-step@v1
    inputs:
      echo: hello ${{ inputs.name }}
  - name: print_system_information
    step: ./my-local-steps/uname

단계 구현을 리팩토링할 수 있도록, 단계를 exec에서 steps 유형으로, exec에서 steps 유형으로 변경하면 워크플로에 영향을 미치지 않습니다.

입력

입력은 다음과 같은 유형일 수 있습니다: - string - number - boolean - array - struct

기본 입력 유형은 string입니다.

입력에 기본값이 정의되지 않으면 필수입니다. 기본값은 단계 정의에서만 허용되는 표현식 (${{ }})을 사용할 수 없습니다.

출력

출력은 다음과 같은 유형일 수 있습니다: - string - number - boolean - array - struct - raw_string - step_result

출력은 ${{ output_file }}에 key=value 형식으로 작성되며, 여기서 key는 출력의 이름입니다. value는 유형이 raw_string이 아니라면 JSON으로 작성되어야 합니다. 단계에서 작성한 값의 유형은 선언된 유형과 일치해야 합니다. 기본 출력 유형은 raw_string입니다.

특수한 출력 유형인 step_result는 단계 실행을 다른 단계로 위임할 때 사용됩니다. 예를 들어, script 및 action-runner 단계입니다.

steps 유형 정의의 출력은 하위 단계 출력에서 집계하기 위해 표현식을 사용합니다. 사양에서 표현식은 허용되지 않기 때문에 outputs 키워드가 정의에서 나타납니다. 캡슐화를 유지하고 리팩토링을 허용하기 위해 호출자는 하위 단계의 출력을 직접 액세스할 수 없습니다.

# 여러 단계에서의 출력 예시
spec:
  outputs:
    full_name:
      type: string
---
steps:
  - name: first_name
    step: ./fn
  - name: last_name
    step: ./ln
outputs:
  full_name: "hello ${{ steps.first_name.outputs.name }} ${{ steps.last_name.outputs.name }}"

단계 사용

키워드 step은 원격 또는 로컬 단계를 가리킵니다.

원격 단계 참조는 Git 리포지토리의 URL, 문자 @, 태그 또는 브랜치(버전)입니다. 단계 실행기는 저장소의 루트에있는 step.yml 파일을 찾습니다.

로컬 단계는 .로 시작하고 단계 실행기가 step.yml을 찾을 디렉터리를 가리킵니다. 로컬 참조는 운영 체제에 관계없이 항상 경로 분리기 /를 사용합니다. 파일을 로드할 때 OS 적절한 분리기가 사용됩니다.

# 단계 사용하는 작업 예시
my-job:
  run:
    - name: greet_user
      step: gitlab.com/gitlab-org/ci-cd/runner-tools/echo-step@v1
      inputs:
        echo: hello $[[ GITLAB_USER_LOGIN ]]
    - name: print_system_information
      step: ./my-local-steps/uname

작업에서 단계를 사용하려면 변수에 단계를 제공하고 작업의 script 키워드에서 단계 실행기를 호출하십시오. GitLab CI 파이프라인 구성에서 ‘run’ 키워드로 단계를 사용하는 지원이 epic 11525에서 제안되었습니다.

# run 키워드가 구현될 때까지의 예시
my-job:
  image: registry.gitlab.com/gitlab-org/step-runner:v0
  variables:
    STEPS: |
      - name: greet_user
        step: gitlab.com/gitlab-org/ci-cd/runner-tools/echo-step@v1
        inputs:
          echo: hello $GITLAB_USER_LOGIN
      - name: print_system_information
        step: ./my-local-steps/uname
  script:
    # STEPS 환경 변수에서 간직된 단계 실행 기동 명령을 실행
    - /step-runner ci

환경 변수 설정

단계에 대해 환경 변수를 선언할 필요가 없습니다. ${{ export_file }}에 작성된 모든 내보내기는 전역 실행 환경에 추가됩니다. 내보낸 값은 플레인 문자열입니다(JSON 없음).

단계에 대해 환경 변수를 임시로 설정하려면 env 키워드를 사용할 수 있습니다.

# env를 사용한 작업 예시
my-job:
  run:
    - name: greet_user
      step: gitlab.com/gitlab-org/ci-cd/runner-tools/echo-step@v1
      env:
        USER: $[[ GITLAB_USER_LOGIN ]]
      inputs:
        echo: hello ${{ env.USER }}

단계 정의는 임시로 환경 변수를 설정할 수도 있습니다.

# (여기에 사양이 들어갑니다)
---
# env를 사용한 단계 정의의 예시
env:
  USER: ${{ inputs.user }}
steps:
  - name: greet_user
    step: gitlab.com/gitlab-org/ci-cd/runner-tools/echo-step@v1
    inputs:
      echo: hello ${{ env.USER }}

환경 변수의 우선 순위는 다음과 같습니다: 1. 단계 정의 1. 단계 참조(단계 호출) 1. 전역 환경

단계 정의에서 설정된 env 변수가 단계를 호출할 때 설정된 변수 및 이후의 변수를 재정의합니다.

로컬에서 단계 실행

로컬에서 단계를 실행하려면 step-runner를 다운로드하고 ci 명령을 실행하십시오. 이것은 프로덕션에서 단계를 실행하는 데 사용되는 동일한 이진 파일입니다.

STEPS=$(yq '."my-job"'.run .gitlab-ci.yml) step-runner ci

go-delve/delve로 디버깅할 수 있습니다. pkg/runner/runner.go의 Run에서 중단점을 설정하세요.

STEPS=$(yq '."my-job"'.run .gitlab-ci.yml) dlv debug . ci

스크립트

단계 대신 쉘 스크립트를 사용하는 경우가 있으며, 때로는 여전히 쉘 스크립트가 필요합니다. script 키워드는 올바른 쉘을 자동으로 선택하고 스크립트를 실행합니다.

# 스크립트를 사용하는 예시 작업
my-job:
  run:
    - name: greet_user
      script: echo hello $[[ GITLAB_USER_LOGIN ]]

참고: bash 쉘만 지원됩니다. 조건식을 지원하는 것은 epic 12168에서 제안되었습니다.

동작

action 키워드로 GitHub 액션을 실행할 수 있습니다. 입력 및 출력은 단계와 동일한 방식으로 작동합니다. 단계와 동작은 서로 교차로 사용할 수 있습니다.

# 액션을 사용하는 예시 작업
my-job:
  run:
    - name: greet_user
      step: gitlab.com/gitlab-org/ci-cd/runner-tools/echo-step@v1
      inputs:
        echo: hello $[[ GITLAB_USER_LOGIN ]]
    - name: greet_user_again
      action: mikefarah/yq@master
      inputs:
        cmd: echo ["${{ steps.greet_user.outputs.echo }} again!"] | yq .[0]

알려진 이슈

GitLab에서 실행 중인 액션은 직접 아티팩트를 업로드하는 것을 지원하지 않습니다. 아티팩트는 파일 시스템과 캐시에 작성되어 기존의 artifacts 키워드로 선택해야 합니다.

액션 실행에는 dind 서비스가 필요합니다. 더 많은 정보는 Docker를 사용하여 Docker 이미지 빌드를 참조하십시오.

GitLab의 액션은 실험적이며 버그가 있을 수 있습니다. 버그를 보고하려면 action-runner 저장소에서 이슈를 생성하십시오.

표현식

표현식은 이중 중괄호 (${{ }})로 둘러싸인 미니 언어입니다. inputs, env (단계 간에 공유하는 환경) 및 이전 단계의 출력 (steps.<step_name>.outputs)을 참조할 수 있습니다.

표현식은 빌드 디렉토리인 work_dir을 참조할 수도 있습니다. 그리고 출력과 익스포트를 쓸 위치인 output_file과 export_file도 참조할 수 있습니다.

표현식은 작업 생성 시 평가되는 템플릿 내삽과는 다릅니다. 템플릿 내삽은 이중 대괄호($[[ ]])를 사용하며 작업 생성 중에 평가됩니다. 표현식은 작업 환경에서 단계 실행 직전에 평가됩니다.

CI/CD 단계

단계 정의

입력

출력

단계 사용

환경 변수 설정

로컬에서 단계 실행

스크립트

동작

알려진 이슈

표현식

도움말

기능 사용 가능성과 제품 평가판

도움받기