릴리스 CI/CD 예제

GitLab 릴리스 기능은 유연하며, 여러분의 워크플로우에 맞게 구성할 수 있습니다. 이 페이지에서는 예제 CI/CD 릴리스 작업을 보여줍니다. 각 예제는 CI/CD 파이프라인에서 릴리스를 생성하는 방법을 시연합니다.

Git 태그가 생성될 때 릴리스 생성

이 CI/CD 예제에서 릴리스는 다음 이벤트 중 하나에 의해 트리거됩니다:

  • 저장소에 Git 태그를 푸시합니다.
  • UI에서 Git 태그를 생성합니다.

이 방법은 Git 태그를 수동으로 생성하고 그 결과로 릴리스를 생성하는 것을 선호하는 경우 사용할 수 있습니다.

참고: UI에서 Git 태그를 생성할 때 릴리스 노트를 제공하지 마세요. 릴리스 노트를 제공하면 릴리스를 생성하게 되어 파이프라인이 실패하게 됩니다.

다음 예시 .gitlab-ci.yml 파일의 주요 내용:

  • rules 구문은 작업이 파이프라인에 추가될 때를 정의합니다.
  • Git 태그는 릴리스의 이름과 설명에 사용됩니다.
release_job:
  stage: release
  image: registry.gitlab.com/gitlab-org/release-cli:latest
  rules:
    - if: $CI_COMMIT_TAG                 # 태그가 생성되었을 때 이 작업을 실행
  script:
    - echo "running release_job"
  release:                               # 사용 가능한 속성에 대한 자세한 내용은 https://docs.gitlab.com/ee/ci/yaml/#release를 참조하세요.
    tag_name: '$CI_COMMIT_TAG'
    description: '$CI_COMMIT_TAG'

기본 브랜치에 커밋이 병합될 때 릴리스 생성

이 CI/CD 예제에서 릴리스는 기본 브랜치에 커밋을 병합할 때 트리거됩니다. 이 방법은 릴리스 워크플로우에서 태그를 수동으로 생성하지 않는 경우 사용할 수 있습니다.

다음 예시 .gitlab-ci.yml 파일의 주요 내용:

  • Git 태그, 설명 및 참조는 파이프라인에서 자동으로 생성됩니다.
  • 수동으로 태그를 생성하는 경우 release_job 작업은 실행되지 않습니다.
release_job:
  stage: release
  image: registry.gitlab.com/gitlab-org/release-cli:latest
  rules:
    - if: $CI_COMMIT_TAG
      when: never                                  # 태그가 수동으로 생성되었을 때 이 작업을 실행하지 않음
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH  # 기본 브랜치에 커밋이 푸시되거나 병합되었을 때 이 작업을 실행
  script:
    - echo "running release_job for $TAG"
  release:                                         # 사용 가능한 속성에 대한 자세한 내용은 https://docs.gitlab.com/ee/ci/yaml/#release를 참조하세요.
    tag_name: 'v0.$CI_PIPELINE_IID'                # 버전은 파이프라인에 따라 증가합니다.
    description: 'v0.$CI_PIPELINE_IID'
    ref: '$CI_COMMIT_SHA'                          # 태그는 파이프라인 SHA로부터 생성됩니다.

참고: before_script 또는 script에서 설정된 환경 변수는 동일한 작업에서 확장할 수 없습니다. 변수를 확장할 수 있도록 설정하는 방법에 대해 자세히 알아보세요.

사용자 지정 스크립트에서 릴리스 메타데이터 생성

이 CI/CD 예제에서는 릴리스 준비를 더 큰 유연성을 위해 개별 작업으로 나누었습니다:

  • prepare_job 작업은 릴리스 메타데이터를 생성합니다. 사용자 지정 이미지를 포함하여 어떤 이미지를 사용하여 작업을 실행할 수 있습니다. 생성된 메타데이터는 변수 파일 variables.env에 저장됩니다. 이 메타데이터는 다운스트림 작업으로 전달됩니다.
  • release_job은 변수 파일에서 내용을 사용하여 릴리스를 생성하며, 이 변수 파일에서 전달된 메타데이터를 사용합니다. 이 작업은 릴리스 CLI가 포함된 registry.gitlab.com/gitlab-org/release-cli:latest 이미지를 사용해야 합니다.
prepare_job:
  stage: prepare                                              # 이 단계는 릴리스 단계 전에 실행되어야 합니다.
  rules:
    - if: $CI_COMMIT_TAG
      when: never                                             # 태그가 수동으로 생성되었을 때 이 작업을 실행하지 않음
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH             # 기본 브랜치에 커밋이 푸시되거나 병합되었을 때 이 작업을 실행
  script:
    - echo "EXTRA_DESCRIPTION=some message" >> variables.env  # EXTRA_DESCRIPTION 및 TAG 환경 변수를 생성합니다.
    - echo "TAG=v$(cat VERSION)" >> variables.env             # 그리고 variables.env 파일에 추가합니다.
  artifacts:
    reports:
      dotenv: variables.env                                   # artifacts:reports:dotenv를 사용하여 변수를 다른 작업에 노출합니다.

release_job:
  stage: release
  image: registry.gitlab.com/gitlab-org/release-cli:latest
  needs:
    - job: prepare_job
      artifacts: true
  rules:
    - if: $CI_COMMIT_TAG
      when: never                                  # 태그가 수동으로 생성되었을 때 이 작업을 실행하지 않음
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH  # 기본 브랜치에 커밋이 푸시되거나 병합되었을 때 이 작업을 실행
  script:
    - echo "running release_job for $TAG"
  release:
    name: 'Release $TAG'
    description: 'Created using the release-cli $EXTRA_DESCRIPTION'  # $EXTRA_DESCRIPTION 및 $TAG
    tag_name: '$TAG'                                                 # 변수가 다른 곳에서 정의되어야 합니다.
    ref: '$CI_COMMIT_SHA'                                            # 파이프라인 내에서. 예를 들어, 
    milestones:                                                      # prepare_job
      - 'm1'
      - 'm2'
      - 'm3'
    released_at: '2020-07-15T08:00:00Z'  # 선택적이며, 정의되지 않은 경우 자동으로 생성됩니다. 또는 변수를 사용할 수 있습니다.
    assets:
      links:
        - name: 'asset1'
          url: 'https://example.com/assets/1'
        - name: 'asset2'
          url: 'https://example.com/assets/2'
          filepath: '/pretty/url/1' # 선택적
          link_type: 'other' # 선택적

릴리스를 생성할 때 여러 파이프라인 건너뛰기

CI/CD 작업을 사용하여 릴리스를 생성할 경우, 관련 태그가 이미 존재하지 않으면 여러 파이프라인이 트리거될 수 있습니다. 이것이 어떻게 발생할 수 있는지 이해하기 위해 다음의 워크플로우를 고려하세요:

  • 먼저 태그를 만들고, 그 다음에 릴리스:

    1. UI를 통해 태그가 생성되거나 푸시됩니다.
    2. 태그 파이프라인이 트리거되고, release 작업이 실행됩니다.
    3. 릴리스가 생성됩니다.

  • 먼저 릴리스를 만들고, 그 다음에 태그:

    1. 기본 브랜치에 커밋이 푸시되거나 병합될 때 파이프라인이 트리거됩니다. 파이프라인은 release 작업을 실행합니다.
    2. 릴리스가 생성됩니다.
    3. 태그가 생성됩니다.
    4. 태그 파이프라인이 트리거됩니다. 이 파이프라인도 release 작업을 실행합니다.

두 번째 워크플로우에서는 release 작업이 여러 파이프라인에서 실행됩니다. 이를 방지하기 위해 workflow:rules 키워드를 사용하여 태그 파이프라인에서 릴리스 작업을 실행해야 하는지를 결정할 수 있습니다:

release_job:
  rules:
    - if: $CI_COMMIT_TAG
      when: never                                  # 태그 파이프라인에서는 이 작업을 실행하지 않음
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH  # 기본 브랜치에 커밋이 푸시되거나 병합될 때 이 작업을 실행함
  script:
    - echo "릴리스 생성"
  release:
    name: '내 멋진 릴리스'
    tag_name: '$CI_COMMIT_TAG'