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

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

이 튜토리얼을 마치면 GitLab.com의 새 프로젝트가 생기고 Docusaurus를 사용하여 작동하는 문서 사이트가 만들어집니다.

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

Docusaurus 파일을 보관할 프로젝트 생성
초기 파이프라인 구성 파일 생성
사이트 빌드 작업 추가
사이트 배포 작업 추가
테스트 작업 추가
Merge Request 파이프라인 사용 시작
중복된 구성 줄이기

전제 조건

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

Docusaurus 파일을 보관할 프로젝트 생성

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

프로젝트를 만들어야 합니다. 프로젝트는 그룹이 아닌 사용자 이름 아래에 만들어야 합니다:
1. 왼쪽 사이드바에서 검색 또는 이동을 선택합니다.
2. 내 모든 프로젝트 보기를 선택합니다.
3. 페이지 오른쪽에서 새 프로젝트를 선택합니다.
4. 빈 프로젝트 생성을 선택합니다.
5. 프로젝트 세부 정보를 입력합니다:
  - 프로젝트 이름 필드에 프로젝트 이름을 입력합니다. 예: 내 파이프라인 튜토리얼 프로젝트.
  - README로 리포지터리 초기화를 선택합니다.
6. 프로젝트 생성을 선택합니다.
프로젝트 개요 페이지에서 페이지 우측 상단에 있는 코드를 선택하여 프로젝트의 클론 경로를 찾습니다. SSH 또는 HTTP 경로를 복사하고 경로를 사용하여 프로젝트를 로컬로 클론합니다.
예를 들어 컴퓨터의 pipeline-tutorial 디렉터리로 SSH로 클론하려면:
```
git clone git@gitlab.com:my-username/my-pipeline-tutorial-project.git pipeline-tutorial
```
프로젝트 디렉터리로 이동한 다음 새 Docusaurus 사이트를 생성합니다:
```
cd pipeline-tutorial
npm init docusaurus
```
Docusaurus 초기화 마법사가 사이트에 대해 질문을 표시합니다. 모든 기본 옵션을 사용합니다.
초기화 마법사는 사이트를 website/에 설정하지만 사이트는 프로젝트의 루트에 있어야 합니다. 파일을 루트로 옮기고 이전 디렉터리를 삭제합니다:
```
mv website/* .
rm -r website
```
Docusaurus 구성 파일을 GitLab 프로젝트의 세부 정보로 업데이트합니다. docusaurus.config.js에서 다음과 같이 설정합니다:
- url:을 다음 형식의 경로로 설정합니다: https://<내-사용자이름>.gitlab.io/
- baseUrl:을 프로젝트 이름으로 설정합니다. 예: /my-pipeline-tutorial-project/

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

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

초기 CI/CD 구성 파일 생성

프로젝트에서 CI/CD가 활성화되어 있고 작업자가 작업을 실행할 수 있는지 확인하기 위해 가장 간단한 파이프라인 구성 파일로 시작합니다.

이 단계에서는 .gitlab-ci.yml 파일을 다음 구성으로 프로젝트 루트에 생성합니다:

test-job:
  script:
    - echo "This is my first job!"
    - date

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

빌드 > 파이프라인으로 이동하여 GitLab에서 이 단일 작업을 실행하는 파이프라인이 있는지 확인합니다.
파이프라인을 선택한 다음 작업을 선택하여 작업 로그를 보고 This is my first job! 메시지 다음에 날짜가 표시되는지 확인합니다.

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

사이트 빌드 작업 추가

CI/CD 파이프라인의 일반적인 작업은 프로젝트의 코드를 빌드한 다음 배포하는 것입니다. 먼저 사이트를 빌드하는 작업을 추가합니다.

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

image: 작업을 실행할 Docker 컨테이너를 러너에게 알립니다. 러너는 컨테이너 이미지를 다운로드하고 시작합니다. GitLab 프로젝트를 실행 중인 컨테이너에 복제합니다. 그런 다음 script 명령을 하나씩 실행합니다.
artifacts: 작업은 자체적으로 리소스를 공유하지 않습니다. 하나의 작업에서 생성된 파일을 다른 작업에서 사용하려면 먼저 이를 아티팩트로 저장해야 합니다. 그런 다음 나중의 작업에서 아티팩트를 검색하고 생성된 파일을 사용할 수 있습니다.

이 단계에서 test-job을 build-job으로 대체합니다:

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

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

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

npm 명령이 실행되고 사이트가 빌드되는 것을 볼 수 있습니다.
마지막으로 아티팩트가 저장된 것을 확인할 수 있습니다.
작업이 완료된 후 작업 로그 오른쪽에있는 찾아보기를 선택하여 아티팩트 파일의 내용을 검색할 수 있습니다.

사이트를 배포하는 작업 추가

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 사이트를 배포하는 GitLab 프로세스인 pages-deploy 작업이 나타납니다. 해당 작업이 완료되면 새로운 Docusaurus 사이트로 이동할 수 있습니다. Pages 문서에서는 URL 서식을 설명하며, 해당 URL은 https://<my-username>.gitlab.io/<my-pipeline-tutorial-project>/와 유사해야 합니다.

테스트 작업 추가

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

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

allow_failure: 때로는 실패하는 작업이나 예상대로 실패하는 작업은 프로덕션성을 떨어뜨리거나 문제 해결이 어려울 수 있습니다. allow_failure을 사용하여 파이프라인 실행을 중지시키지 않고 작업이 실패하도록 허용합니다.
dependencies: dependencies를 사용하여 개별 작업에서 artifact 다운로드를 제어합니다.

이 단계에서 다음을 진행합니다:

build 및 deploy 사이에 실행되는 새로운 test 단계를 추가합니다. 이 세 단계는 구성에 stages가 정의되지 않은 경우 기본 단계입니다.
lint-markdown 작업을 추가하여 markdownlint를 실행하고 프로젝트의 Markdown을 확인합니다. markdownlint는 Markdown 파일이 형식 규칙을 따르는지 확인하는 정적 분석 도구입니다.
- Docusaurus가 생성하는 샘플 Markdown 파일은 blog/ 및 docs/에 있습니다.
- 이 도구는 원본 Markdown 파일만을 스캔하며, build-job artifact에 저장된 생성된 HTML이 필요하지 않습니다. 따라서 dependencies: []로 작업을 가속화합니다.
- 일부 샘플 Markdown 파일은 기본 markdownlint 규칙을 위반하므로 allow_failure: true를 추가하여 규칙 위반에도 불구하고 파이프라인을 계속 진행합니다.
test-html 작업을 추가하여 HTMLHint를 실행하고 생성된 HTML을 확인합니다. HTMLHint는 생성된 HTML을 알려진 문제에 대해 스캔하는 정적 분석 도구입니다.
test-html 및 pages 모두 build-job artifact에 저장된 생성된 HTML이 필요합니다. 작업은 기본적으로 이전 단계의 모든 작업에서 artifact를 가져옵니다. 그러나 향후 파이프라인 변경 후 실수로 다른 artifact를 다운로드하지 않도록 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: []     # artifact를 가져오지 않음
  script:
    - npm install markdownlint-cli2 --global           # container에 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`에서만 artifact를 가져옴
  script:
    - npm install --save-dev htmlhint                  # container에 HTMLHint 설치
    - npx htmlhint --version                           # 버전 확인, 문제 해결에 유용
    - npx htmlhint build/                              # blog/ 및 docs/의 모든 markdown 파일 lint

pages:
  stage: deploy
  dependencies:
    - build-job        # `build-job`에서만 artifact를 가져옴
  script:
    - mv build/ public/
  artifacts:
    paths:
      - "public/"

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

test-markdown 작업은 샘플 Markdown이 기본 markdownlint 규칙을 위반하므로 실패하지만 실패를 허용합니다. 다음을 수행할 수 있습니다:
- 현재 위반사항 무시. 본 자습서의 일부로 수정할 필요는 없습니다.
- Markdown 파일 위반 조치. 그런 다음 allow_failure: false로 변경하거나 allow_failure를 완전히 삭제할 수 있습니다. allow_failure: false는 미정의시 기본 동작입니다.
- markdownlint 구성 파일을 추가하여 경고할 rule 위반을 제한할 수 있습니다.
Markdown 파일 내용을 변경하고 다음 배포 후 사이트 변경을 볼 수도 있습니다.

머지 요청 파이프라인 사용 시작

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

이 단계에서 소개되는 내용은 다음과 같습니다:

rules: 각 작업에 규칙을 추가하여 파이프라인에서 실행되는 경우를 구성합니다. 머지 요청 파이프라인, 예약된 파이프라인 또는 다른 특정 상황에서 작업을 구성할 수 있습니다. 규칙은 위에서 아래로 평가되며 규칙이 일치하면 작업이 파이프라인에 추가됩니다.
CI/CD 변수: 구성 파일 및 스크립트 명령어에서 작업 동작을 구성하는 데에 이러한 환경 변수를 사용합니다. Predefined 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      # 기본 브랜치의 모든 변경 사항에 대해서만 실행

머지 요청에서 변경 사항을 머지하세요. 이 동작은 기본 브랜치를 업데이트합니다. 새로운 파이프라인에 “page” 작업이 포함되는지 확인하세요.

향후 파이프라인 구성 변경 사항에 대해 모두 기능 브랜치와 머지 요청을 사용하도록 하십시오. Git 태그를 만들거나 파이프라인 스케줄을 추가하는 등의 다른 프로젝트 변경은 해당 사례의 규칙을 추가하지 않는 한 파이프라인을 트리거하지 않습니다.

중복 구성 줄이기

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

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

숨겨진 작업: .로 시작하는 작업은 절대로 파이프라인에 추가되지 않습니다. 재사용하고 싶은 구성을 보관하는 데 사용합니다.
extends: 숨겨진 작업에서 종종 구성을 반복하는 데 사용됩니다. 숨겨진 작업의 구성을 업데이트하면 확장된 모든 작업이 업데이트된 구성을 사용합니다.
default: 정의되지 않은 경우 모든 작업에 적용되는 키워드 기본값을 설정하세요.
YAML 오버라이딩: extends 또는 default를 사용하여 구성을 재사용할 때, 작업에서 명시적으로 키워드를 정의하여 extends 또는 default 구성을 재정의할 수 있습니다.