• 전제 조건
• Docusaurus 파일을 보관할 프로젝트 만들기
• 초기 CI/CD 구성 파일 만들기
• 사이트 빌드를 위한 작업 추가
• 사이트 배포를 위한 작업 추가
• 테스트 작업 추가
• 병합 요청 파이프라인 사용 시작하기
• 중복 구성 감소

튜토리얼: 복잡한 파이프라인 생성

이 튜토리얼은 작은 반복적인 단계를 통해 점진적으로 더 복잡한 CI/CD 파이프라인을 구성하는 방법을 안내합니다. 이 파이프라인은 항상 완전히 기능하며 각 단계마다 더 많은 기능을 얻습니다. 이 튜토리얼의 목표는 문서 사이트를 빌드, 테스트 및 배포하는 것입니다.

이 튜토리얼을 완료하면 GitLab.com에서 새 프로젝트와 Docusaurus를 사용하여 작동하는 문서 사이트가 있게 될 것입니다.

이 튜토리얼을 완료하려면 다음을 수행해야 합니다:

1. Docusaurus 파일을 보관할 프로젝트를 만듭니다.
2. 초기 파이프라인 구성 파일을 만듭니다.
3. 사이트를 빌드하는 작업을 추가합니다.
4. 사이트를 배포하는 작업을 추가합니다.
5. 테스트 작업을 추가합니다.
6. 병합 요청 파이프라인 사용 시작
7. 구성된 중복 감소

전제 조건

• GitLab.com에 계정이 필요합니다.
• Git을 잘 알고 있어야 합니다.
• 로컬 컴퓨터에 Node.js가 설치되어 있어야 합니다. 예를 들어 macOS에서는 다음과 같이 node를 설치할 수 있습니다: brew install node.

Docusaurus 파일을 보관할 프로젝트 만들기

파이프라인 구성을 추가하기 전에, 먼저 GitLab.com에 Docusaurus 프로젝트를 설정해야 합니다.

1. 사용자 이름(그룹이 아님) 아래에 새 프로젝트를 만들어야 합니다:
   1. 왼쪽 사이드바에서 검색 또는 이동을 선택합니다.
   2. 내 모든 프로젝트 보기를 선택합니다.
   3. 페이지 오른쪽에서 새 프로젝트를 선택합니다.
   4. 빈 프로젝트 생성을 선택합니다.
   5. 프로젝트 세부 정보를 입력합니다:
      • 프로젝트 이름 필드에 프로젝트 이름을 입력합니다. 예: 내 파이프라인 튜토리얼 프로젝트.
      • README로 저장소 초기화를 선택합니다.
   6. 프로젝트 만들기를 선택합니다.

2. 프로젝트 개요 페이지에서 오른쪽 상단에 있는 코드를 선택하여 프로젝트의 클론 경로를 찾습니다. SSH 또는 HTTP 경로를 복사하여 프로젝트를 로컬로 클론합니다.

   예를 들어, 컴퓨터의 pipeline-tutorial 디렉토리에 SSH로 클론하려면:

   git clone git@gitlab.com:내-사용자이름/내-파이프라인-튜토리얼-프로젝트.git pipeline-tutorial
   

3. 프로젝트 디렉토리로 이동한 다음 새 Docusaurus 사이트를 생성합니다:

   cd pipeline-tutorial
   npm init docusaurus
   

   Docusaurus 초기화 위자드에서 사이트에 대한 질문이 표시됩니다. 모든 기본 옵션을 사용하세요.

4. 초기화 위자드는 사이트를 website/에 설정하지만, 사이트는 프로젝트 루트에 있어야 합니다. 파일을 루트로 이동하고 이전 디렉토리를 삭제합니다:

   mv website/* .
   rm -r website
   

5. Docusaurus 구성 파일을 GitLab 프로젝트의 세부 정보로 업데이트합니다. docusaurus.config.js에서:

   • url:을 다음 형식의 경로로 설정합니다: https://<내-사용자이름>.gitlab.io/.
   • baseUrl:를 프로젝트 이름으로 설정합니다. 예: /내-파이프라인-튜토리얼-프로젝트/.

6. 변경 사항을 커밋하고 GitLab에 푸시합니다:

   git add .
   git commit -m "간단히 생성된 Docusaurus 사이트 추가"
   git push origin
   

초기 CI/CD 구성 파일 만들기

프로젝트 루트에 .gitlab-ci.yml 파일을 만들고 다음 구성으로 시작하여 CI/CD가 프로젝트에 활성화되고 작업을 실행할 수 있는 러너가 사용 가능한지 확인합니다:

test-job:
  script:
    - echo "이것은 내 첫 번째 작업입니다!"
    - date

이 변경 사항을 커밋하고 GitLab에 푸시한 다음:

1. 빌드 > 파이프라인으로 이동하여 GitLab에서 이 단일 작업이 있는 파이프라인이 실행되는지 확인합니다.
2. 파이프라인을 선택한 다음 작업을 선택하여 작업 로그를 보고 이것은 내 첫 번째 작업입니다! 메시지와 날짜가 표시되는지 확인합니다.

이제 프로젝트에 .gitlab-ci.yml 파일이 있으므로 파이프라인 편집기를 사용하여 이후 모든 변경 사항을 파이프라인 구성에 적용할 수 있습니다.

사이트 빌드를 위한 작업 추가

CI/CD 파이프라인의 일반적인 작업은 프로젝트의 코드를 빌드한 뒤 배포하는 것입니다. 우선 사이트를 빌드하는 작업을 추가하는 것으로 시작하세요.

이 단계에서는 다음을 소개합니다:

• image: 러너에게 작업을 실행할 Docker 컨테이너를 지정합니다. 러너는 다음을 수행합니다:
  1. 컨테이너 이미지를 다운로드하고 시작합니다.
  2. GitLab 프로젝트를 실행 중인 컨테이너에 복제합니다.
  3. script 명령을 차례대로 실행합니다.
• artifacts: 작업은 독립적이며 서로의 리소스를 공유하지 않습니다. 한 작업에서 생성된 파일을 다른 작업에서 사용하려면 먼저 해당 파일을 artifacts로 저장해야 합니다. 그런 다음 이후 작업에서 해당 artifacts을 검색하여 생성된 파일을 사용할 수 있습니다.

이 단계에서 test-job을 build-job으로 대체하세요:

• image를 사용하여 작업을 최신 node 이미지로 구성합니다. Docusaurus는 Node.js 프로젝트이며 node 이미지에 필요한 npm 명령이 내장되어 있습니다.
• npm install을 실행하여 Docusaurus를 실행 중인 node 컨테이너에 설치한 다음, npm run build로 사이트를 빌드합니다.
• Docusaurus는 빌드된 사이트를 build/에 저장하므로 이 파일을 artifacts로 저장하세요.

build-job:
  image: node
  script:
    - npm install
    - npm run build
  artifacts:
    paths:
      - "build/"

파이프라인 편집기를 사용하여 이 파이프라인 구성을 기본 브랜치에 커밋하고 작업 로그를 확인할 수 있습니다.

• npm 명령이 실행되어 사이트를 빌드하는 것을 볼 수 있습니다.
• 마지막에 artifacts이 저장된 것을 확인할 수 있습니다.
• 작업이 완료된 후 작업 로그 오른쪽에 있는 Browse를 선택하여 artifacts 파일 내용을 찾아볼 수 있습니다.

사이트 배포를 위한 작업 추가

build-job에서 Docusaurus 사이트를 빌드하는 것을 확인한 후, 해당 사이트를 배포하는 작업을 추가할 수 있습니다.

이 단계에서는 다음을 소개합니다:

• stage 및 stages: 가장 일반적인 파이프라인 구성은 작업을 단계로 그룹화합니다. 동일한 단계에 속한 작업은 병렬로 실행될 수 있으며, 나중 단계에 속한 작업은 앞 단계의 작업이 완료될 때까지 기다립니다. 작업이 실패하면 전체 단계가 실패로 간주되어 나중 단계의 작업이 실행되지 않습니다.
• GitLab Pages: 정적 사이트를 호스팅하기 위해 GitLab Pages를 사용합니다.

이 단계에서 다음을 수행하세요:

• 빌드된 사이트를 가져와 배포하는 작업을 추가하세요. GitLab Pages를 사용할 때, 해당 작업은 항상 pages로 명명됩니다. build-job에서의 artifacts은 자동으로 가져와 작업에 추출됩니다. Pages는 사이트를 항상 public/ 디렉터리에서 찾으므로 해당 디렉터리로 사이트를 이동하는 script 명령을 추가하세요.
• stages 섹션을 추가하고 각 작업에 대한 단계를 정의하세요. build-job은 build 단계에서 먼저 실행되며, 그 후 pages가 deploy 단계에서 실행됩니다.

stages:          # 작업 및 실행 순서에 대한 단계 목록
  - build
  - deploy

build-job:
  stage: build   # 이 작업을 `build` 단계에서 실행하도록 설정
  image: node
  script:
    - npm install
    - npm run build
  artifacts:
    paths:
      - "build/"

pages:
  stage: deploy  # 새로운 작업을 `deploy` 단계에서 실행하도록 설정
  script:
    - mv build/ public/
  artifacts:
    paths:
      - "public/"

이 파이프라인 구성을 기본 브랜치에 커밋하고 파이프라인 목록에서 파이프라인 세부 정보를 확인하세요.

• 두 작업이 서로 다른 단계인 build 및 deploy에서 실행되는 것을 확인할 수 있습니다.
• pages 작업이 완료되면 pages-deploy 작업이 나타나며, 이는 Pages 사이트를 배포하는 GitLab 프로세스입니다. 해당 작업이 완료되면 새 Docusaurus 사이트를 방문할 수 있습니다. Pages 문서에서는 URL 형식을 설명하고 있습니다. 이 URL은 https://<내-사용자명>.gitlab.io/<내-파이프라인-튜토리얼-프로젝트>/와 유사할 것입니다.

테스트 작업 추가

이제 사이트가 기대한 대로 빌드되고 배포되었으므로 테스트 및 린팅을 추가할 수 있습니다. 예를 들어, Ruby 프로젝트에서는 RSpec 테스트 작업을 실행할 수 있습니다. Docusaurus는 Markdown 및 생성된 HTML을 사용하는 정적 사이트이므로 이 튜토리얼에서 Markdown 및 HTML 테스트 작업을 추가합니다.

이 단계에서 다음을 소개합니다:

• allow_failure: 간헐적으로 실패하는 작업 또는 예상대로 실패하는 작업은 생산성을 저하시키거나 문제 해결이 어려울 수 있습니다. allow_failure를 사용하여 작업이 실패해도 파이프라인 실행이 중단되지 않도록 설정할 수 있습니다.
• dependencies: dependencies를 사용하여 각 작업에서 artifacts를 제어할 수 있습니다. 이는 개별 작업에서 다른 작업에서 artifacts를 가져올 작업을 나열함으로써 수행합니다.

이 단계에서 다음을 수행하세요:

• build 및 deploy 사이에 실행되는 새 test 단계를 추가하세요. 이러한 세 단계는 구성에서 stages가 정의되지 않았을 때의 기본 단계입니다.
• lint-markdown 작업을 추가하여 markdownlint를 실행하고 프로젝트의 Markdown을 확인하세요. markdownlint는 Markdown 파일이 형식 규칙을 따르는지 확인하는 정적 분석 도구입니다.
  • Docusaurus에서 생성된 샘플 Markdown 파일은 blog/ 및 docs/에 있습니다.
  • 이 도구는 생성된 HTML이 아닌 원본 Markdown 파일만을 스캔하며, build-job의 artifacts을 저장할 필요가 없습니다. dependencies: []를 사용하여 작업을 가속화하세요.
  • 일부 샘플 Markdown 파일은 기본 markdownlint 규칙을 위반하므로 파이프라인이 계속되도록 allow_failure: true를 추가하세요.
• test-html 작업을 추가하여 HTMLHint를 실행하고 생성된 HTML을 확인하세요. HTMLHint는 알려진 문제를 위해 생성된 HTML을 스캔하는 정적 분석 도구입니다.
• test-html 및 pages는 모두 build-job의 artifacts에 있는 생성된 HTML이 필요합니다. 작업은 기본적으로 이전 단계의 모든 작업에서 artifacts을 가져오지만, 다음 파이프라인 변경 후 실수로 다른 artifacts을 다운로드하는 것을 방지하기 위해 dependencies:를 추가하세요.

stages:
  - build
  - test               # 테스트 작업을 위한 `test` 단계 추가
  - deploy

build-job:
  stage: build
  image: node
  script:
    - npm install
    - npm run build
  artifacts:
    paths:
      - "build/"

lint-markdown:
  stage: test
  image: node
  dependencies: []     # 어떤 artifacts도 가져오지 않음
  script:
    - npm install markdownlint-cli2 --global           # 컨테이너에 markdownlint를 설치
    - markdownlint-cli2 -v                             # 버전을 확인하여 문제 해결에 유용함
    - markdownlint-cli2 "blog/**/*.md" "docs/**/*.md"  # blog/ 및 docs/의 모든 markdown 파일을 lint
  allow_failure: true  # 현재 이 작업은 실패하지만 파이프라인이 계속될 수 있도록 함.

test-html:
  stage: test
  image: node
  dependencies:
    - build-job        # `build-job`에서만 artifacts을 가져오도록 지정
  script:
    - npm install --save-dev htmlhint                  # 컨테이너에 HTMLHint를 설치
    - npx htmlhint --version                           # 버전을 확인하여 문제 해결에 유용함
    - npx htmlhint build/                              # blog/ 및 docs/의 모든 markdown 파일을 lint

pages:
  stage: deploy
  dependencies:
    - build-job        # `build-job`에서만 artifacts을 가져오도록 지정
  script:
    - mv build/ public/
  artifacts:
    paths:
      - "public/"

이 파이프라인 구성을 기본 브랜치에 커밋하고 파이프라인 세부 정보를 확인할 수 있습니다.

• 샘플 Markdown이 기본 markdownlint 규칙을 위반하므로 test-markdown 작업이 실패하지만 실패허용으로 설정되어 있습니다. 이제 다음과 같은 작업을 수행할 수 있습니다:
  • 현재 위반 사항을 무시할 수 있습니다. 이것은 튜토리얼의 일부로 수정할 필요가 없습니다.
  • Markdown 파일 위반 사항을 수정할 수 있습니다. 그런 다음 allow_failure를 false로 변경하거나 allow_failure을 삭제하세요. allow_failure: false는 정의되지 않았을 때의 기본 동작입니다.
  • markdownlint 구성 파일을 추가하여 경고를 발생시킬 rule 위반을 제한할 수 있습니다.
• Markdown 파일 내용을 변경하고 다음 배포 후 사이트를 확인할 수 있습니다.

병합 요청 파이프라인 사용 시작하기

위의 파이프라인 구성을 사용하면 사이트가 성공적으로 파이프라인을 완료할 때마다 배포됩니다. 그러나 이는 이상적인 개발 워크플로우가 아닙니다. 기능 브랜치 및 병합 요청에서 작업하고, 변경 사항이 기본 브랜치로 병합될 때에만 사이트를 배포하는 것이 더 나은 방법입니다.

이 단계에서는 다음을 소개합니다:

• rules: 각 작업에 규칙을 추가하여 파이프라인이 실행되는 조건을 구성합니다. 작업을 병합 요청 파이프라인, 예약된 파이프라인 또는 다른 특정 상황에서 실행하도록 구성할 수 있습니다. 규칙은 위에서 아래로 평가되며, 규칙이 일치하면 작업이 파이프라인에 추가됩니다.
• CI/CD 변수: 이러한 환경 변수를 사용하여 설정 파일 및 스크립트 명령에서 작업 동작을 구성합니다. 사전 정의된 CI/CD 변수는 수동으로 정의할 필요가 없는 변수들입니다. 이러한 변수들은 자동으로 파이프라인에 주입되어 파이프라인을 구성하는 데 사용할 수 있습니다. 변수는 일반적으로 $VARIABLE_NAME과 같이 포맷되며, 미리 정의된 변수는 일반적으로 $CI_로 접두어가 붙습니다.

이 단계에서는:

• 새 기능 브랜치를 만들고 기본 브랜치가 아닌 브랜치에서 변경 내용을 만듭니다.
• 각 작업에 rules를 추가합니다.
  • 사이트는 기본 브랜치의 변경 사항에 대해서만 배포되어야 합니다.
  • 다른 작업은 병합 요청 또는 기본 브랜치의 모든 변경에 대해 실행되어야 합니다.
• 이 파이프라인 구성을 사용하면 작업을 실행하지 않고 기능 브랜치에서 작업할 수 있어 리소스를 절약할 수 있습니다. 변경 사항을 확인하려면 병합 요청을 만들고, 작업이 병합 요청에서 실행되도록 구성된 새 파이프라인이 실행됩니다.
• 병합 요청이 승인되고 변경 사항이 기본 브랜치로 병합되면 pages 배포 작업을 포함한 새 파이프라인이 실행됩니다. 작업이 실패하지 않는 한 사이트가 배포됩니다.

stages:
  - build
  - test
  - deploy

build-job:
  stage: build
  image: node
  script:
    - npm install
    - npm run build
  artifacts:
    paths:
      - "build/"
  rules:
    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'  # 병합 요청의 소스 브랜치에 대한 모든 변경에 대해 실행
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH       # 기본 브랜치의 모든 변경에 대해 실행

lint-markdown:
  stage: test
  image: node
  dependencies: []
  script:
    - npm install markdownlint-cli2 --global
    - markdownlint-cli2 -v
    - markdownlint-cli2 "blog/**/*.md" "docs/**/*.md"
  allow_failure: true
  rules:
    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'  # 병합 요청의 소스 브랜치에 대한 모든 변경에 대해 실행
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH       # 기본 브랜치의 모든 변경에 대해 실행

test-html:
  stage: test
  image: node
  dependencies:
    - build-job
  script:
    - npm install --save-dev htmlhint
    - npx htmlhint --version
    - npx htmlhint build/
  rules:
    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'  # 병합 요청의 소스 브랜치에 대한 모든 변경에 대해 실행
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH       # 기본 브랜치의 모든 변경에 대해 실행

pages:
  stage: deploy
  dependencies:
    - build-job
  script:
    - mv build/ public/
  artifacts:
    paths:
      - "public/"
  rules:
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH      # 기본 브랜치의 모든 변경에 대해 실행

병합 요청에서 변경 사항을 병합하십시오. 이 작업은 기본 브랜치를 업데이트합니다. 새 파이프라인에는 사이트를 배포하는 pages 작업이 포함되어 있는지 확인하십시오.

앞으로 파이프라인 구성에 대한 모든 변경에 대해 기능 브랜치와 병합 요청을 사용하십시오. Git 태그를 만들거나 파이프라인 일정을 추가하는 것과 같은 다른 프로젝트 변경은 규칙을 추가하지 않은 이상 파이프라인을 트리거하지 않습니다.

중복 구성 감소

현재 파이프라인에는 모두 동일한 rules 및 image 구성이 있는 세 개의 작업이 포함되어 있습니다. 이러한 규칙을 반복하는 대신 extends 및 default를 사용하여 단일 진실의 원천을 만드십시오.

이 단계에서는 다음을 소개합니다:

• 숨겨진 작업: .으로 시작하는 작업은 결코 파이프라인에 추가되지 않습니다. 재사용하려는 구성을 보관하는 데 사용하십시오.
• extends: 숨겨진 작업에서 구성을 자주 반복하여 여러 위치에서 extends를 사용합니다. 숨겨진 작업의 구성을 업데이트하면 해당 숨겨진 작업을 확장하는 모든 작업이 업데이트된 구성을 사용합니다.
• default: 정의되지 않았을 때 모든 작업에 적용되는 키워드 기본값을 설정하십시오.
• YAML 재정의: extends 또는 default로 구성을 재사용할 때 작업에서 키워드를 명시적으로 재정의할 수 있습니다.

이 단계에서는:

• build-job, lint-markdown, test-html에서 반복되는 규칙을 보관하기 위해 .standard-rules 숨겨진 작업을 추가하십시오.
• extends를 사용하여 세 개의 작업에서 .standard-rules 구성을 재사용하십시오.
• default 섹션을 추가하여 image 기본값을 node로 정의하십시오.
• pages 배포 작업은 기본 node 이미지가 필요하지 않으므로 명시적으로 busybox를 사용하십시오. 이는 극히 작고 빠른 이미지입니다.

stages:
  - build
  - test
  - deploy

default:               # `image` 키워드의 기본값을 정의하기 위해 default 섹션을 추가
  image: node

.standard-rules:       # 반복되는 규칙을 보관하기 위해 숨겨진 작업인 .standard-rules을 생성하십시오
  rules:
    - if: $CI_PIPELINE_SOURCE == 'merge_request_event'
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH

build-job:
  extends:
    - .standard-rules  # `.standard-rules`의 구성을 여기서 재사용합니다
  stage: build
  script:
    - npm install
    - npm run build
  artifacts:
    paths:
      - "build/"

lint-markdown:
  stage: test
  extends:
    - .standard-rules  # `.standard-rules`의 구성을 여기서 재사용합니다
  dependencies: []
  script:
    - npm install markdownlint-cli2 --global
    - markdownlint-cli2 -v
    - markdownlint-cli2 "blog/**/*.md" "docs/**/*.md"
  allow_failure: true

test-html:
  stage: test
  extends:
    - .standard-rules  # `.standard-rules`의 구성을 여기서 재사용합니다
  dependencies:
    - build-job
  script:
    - npm install --save-dev htmlhint
    - npx htmlhint --version
    - npx htmlhint build/

pages:
  stage: deploy
  image: busybox       # 기본 `image` 값을 `busybox`로 재정의합니다
  dependencies:
    - build-job
  script:
    - mv build/ public/
  artifacts:
    paths:
      - "public/"
  rules:
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH

이 파이프라인 구성을 기본 브랜치에 커밋하려면 병합 요청을 사용하십시오. 파일은 더 간단해졌지만 이전 단계와 동일한 동작을 해야 합니다.

이제 전체적인 파이프라인을 만들고 효율적으로 최적화했습니다. 잘 하셨습니다! 이제 이 지식을 활용하여 CI/CD YAML 구문 참조에서 나머지 .gitlab-ci.yml 키워드에 대해 학습하고 나만의 파이프라인을 만들 수 있습니다.