작업 아티팩트

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-Managed, GitLab 전용

작업은 파일 및 디렉터리의 아카이브를 출력할 수 있습니다. 이러한 출력물을 작업 아티팩트라고 합니다.

GitLab UI 또는 API를 사용하여 작업 아티팩트를 다운로드할 수 있습니다.

작업 아티팩트에 대한 개요는 GitLab CI 파이프라인, 아티팩트 및 환경 비디오를 시청하세요. 또는 초기 학습을 위해 GitLab CI 파이프라인 초보자를 위한 자습서를 시청하세요.

관리자용 작업 아티팩트 저장소 정보는 작업 아티팩트 관리를 참조하세요.

작업 아티팩트 생성

작업 아티팩트를 생성하려면 .gitlab-ci.yml 파일에서 artifacts 키워드를 사용하세요:

pdf:
  script: xelatex mycv.tex
  artifacts:
    paths:
      - mycv.pdf

이 예에서 pdf라는 작업은 mycv.tex LaTeX 소스 파일에서 PDF 파일을 빌드하기 위해 xelatex 명령을 호출합니다.

paths 키워드는 작업 아티팩트에 추가할 파일을 결정합니다. 모든 파일 및 디렉터리의 경로는 작업이 생성된 저장소를 기준으로 상대적입니다.

와일드카드 사용

경로 및 디렉터리에 와일드카드를 사용할 수 있습니다. 예를 들어 xyz로 끝나는 디렉터리 내의 모든 파일로 아티팩트를 생성하려면:

job:
  script: echo "build xyz project"
  artifacts:
    paths:
      - path/*xyz/*

만료일 지정

expire_in 키워드는 artifacts:paths에서 정의된 아티팩트를 저장하는데 GitLab이 지속하는 기간을 결정합니다. 예를 들어:

pdf:
  script: xelatex mycv.tex
  artifacts:
    paths:
      - mycv.pdf
    expire_in: 1 week

expire_in이 정의되지 않은 경우, 인스턴스별 설정이 사용됩니다.

아티팩트가 만료되는 것을 방지하려면 작업 세부 정보 페이지에서 유지를 선택할 수 있습니다. 아티팩트에 만료 기간이 설정되지 않은 경우에는 이 옵션이 사용되지 않습니다.

기본적으로 최신 아티팩트는 항상 보관됩니다.

동적으로 정의된 이름으로

CI/CD 변수를 사용하여 아티팩트 파일 이름을 동적으로 정의할 수 있습니다.

예를 들어, 현재 작업의 이름으로 아카이브를 만들려면:

job:
  artifacts:
    name: "$CI_JOB_NAME"
    paths:
      - binaries/

현재 브랜치 또는 태그의 이름으로만 바이너리 디렉터리를 포함하는 아카이브를 만들려면:

job:
  artifacts:
    name: "$CI_COMMIT_REF_NAME"
    paths:
      - binaries/

브랜치 이름에 슬래시가 포함된 경우 (예: feature/my-feature) 아티팩트의 이름을 올바르게 지정하기 위해 $CI_COMMIT_REF_NAME 대신 $CI_COMMIT_REF_SLUG를 사용하세요.

Windows 러너 또는 쉘 실행기 사용 시

Windows 배치를 사용하여 쉘 스크립트를 실행하는 경우 $를 %로 바꿔야 합니다:

job:
  artifacts:
    name: "%CI_JOB_STAGE%-%CI_COMMIT_REF_NAME%"
    paths:
      - binaries/

Windows PowerShell을 사용하여 쉘 스크립트를 실행하는 경우 $를 $env:로 바꿔야 합니다:

job:
  artifacts:
    name: "$env:CI_JOB_STAGE-$env:CI_COMMIT_REF_NAME"
    paths:
      - binaries/

제외된 파일이 없을 때

artifacts:exclude를 사용하여 파일을 아티팩트 아카이브에 추가되지 않도록 할 수 있습니다.

예를 들어, binaries/에 있는 모든 파일을 저장하되, binaries/의 서브디렉터리에 있는 *.o 파일은 저장하지 않으려면:

artifacts:
  paths:
    - binaries/
  exclude:
    - binaries/**/*.o

artifacts:paths와는 달리, exclude 경로는 재귀적이지 않습니다. 디렉터리의 모든 내용을 제외하려면 디렉터리 자체가 아닌 내용을 명시적으로 일치시키세요.

예를 들어, binaries/의 모든 파일은 저장하지만 temp/ 하위 디렉터리 내용은 저장하지 않으려면:

artifacts:
  paths:
    - binaries/
  exclude:
    - binaries/temp/**/*

추적되지 않는 파일 사용

artifacts:untracked를 사용하여 Git 추적되지 않은 모든 파일을 아티팩트로 추가할 수 있습니다(artifacts:paths에서 정의된 경로와 함께). 추적되지 않은 파일은 저장소에 추가되지 않았지만 저장소 체크아웃에 존재하는 파일입니다.

예를 들어, 모든 Git 추적되지 않는 파일과 binaries에 있는 파일을 저장하려면:

artifacts:
  untracked: true
  paths:
    - binaries/

예를 들어, 모든 추적되지 않는 파일을 저장하지만 *.txt 파일을 제외하려면:

artifacts:
  untracked: true
  exclude:
    - "*.txt"

작업에서 아티팩트 가져오지 않게 하기

기본적으로 작업은 이전 단계에서 완료된 작업의 모든 아티팩트를 다운로드합니다. 작업이 아무런 아티팩트도 다운로드하지 않게 하려면 dependencies를 빈 배열([])로 설정하세요:

job:
  stage: test
  script: make build
  dependencies: []

프로젝트의 모든 작업 아티팩트 보기

GitLab 15.6에서 개선된 외관.
GitLab 15.9에서 성능 개선.
GitLab 16.0에서 일반 사용 가능. 기능 플래그 artifacts_management_page가 제거됨.

Build > Artifacts 페이지에서 프로젝트에 저장된 모든 아티팩트를 볼 수 있습니다. 이 목록에는 모든 작업 및 해당하는 아티팩트가 표시됩니다. 항목을 확장하여 작업에 연결된 모든 아티팩트에 액세스할 수 있습니다. 이는 다음을 포함합니다:

artifacts: 키워드로 생성된 아티팩트.
보고서 아티팩트.
내부적으로 별도의 아티팩트로 저장되는 작업 로그 및 메타데이터.

이 목록에서 개별 아티팩트를 다운로드하거나 삭제할 수 있습니다.

작업 자산 다운로드

다음 위치에서 작업 자산을 다운로드할 수 있습니다.

파이프라인 목록. 파이프라인 오른쪽에서 자산 다운로드를 선택하세요 ({다운로드}).
작업 목록. 작업 오른쪽에서 자산 다운로드를 선택하세요 ({다운로드}).
작업 상세 페이지. 페이지 오른쪽에서 다운로드를 선택하세요.
병합 요청 개요 페이지. 최신 파이프라인 오른쪽에서 자산을 선택하세요 ({다운로드}).
자산 페이지. 작업 오른쪽에서 다운로드를 선택하세요 ({다운로드}).
자산 브라우저. 페이지 상단에서, 자산 아카이브 다운로드를 선택하세요 ({다운로드}).

보고서 자산은 파이프라인 목록이나 자산 페이지에서만 다운로드할 수 있습니다.

작업 자산 API를 사용하여 최신 성공한 파이프라인에서 작업 자산을 다운로드할 수 있습니다. 작업 자산 API로는 작업 자산과 함께 보고서 자산을 다운로드할 수 없습니다. 보고서가 artifacts:paths와 함께 일반 자산으로 추가된 경우에만 가능합니다.

URL을 사용하여

공개적으로 접근 가능한 URL을 사용하여 특정 작업의 자산 아카이브를 다운로드할 수 있습니다. 예를 들어:

GitLab.com의 프로젝트의 main 브랜치에 있는 build이라는 작업의 최신 자산을 다운로드하려면:
```
https://gitlab.com/api/v4/projects/<project-id>/jobs/artifacts/main/download?job=build
```
GitLab.com의 프로젝트의 main 브랜치에 있는 build이라는 작업의 최신 review/index.html 파일을 다운로드하려면:
```
https://gitlab.com/api/v4/projects/<project-id>/jobs/artifacts/main/raw/review/index.html?job=build
```
이 엔드포인트에서 반환된 파일은 항상 plain/text 콘텐츠 유형을 가지고 있습니다.

두 예시 모두 <project-id>를 유효한 프로젝트 ID로 교체하셔야 합니다. 프로젝트 ID는 프로젝트 개요 페이지에서 확인할 수 있습니다.

상위 및 하위 파이프라인의 자산은 상위에서 하위로 계층 순으로 검색됩니다. 예를 들어, 부모 및 자식 파이프라인에 동일한 이름의 작업이 있는 경우 부모 파이프라인의 작업 자산이 반환됩니다.

CI/CD 작업 토큰을 사용하여

Tier: 프리미엄, 얼티밋 Offering: GitLab.com, Self-managed, GitLab Dedicated

CI/CD 작업 토큰을 사용하여 작업 자산 API 엔드포인트에 인증하고 다른 파이프라인에서 자산을 검색할 수 있습니다. 가져올 작업을 지정해야 합니다. 예를 들어:

build_submodule:
  stage: test
  script:
    - apt update && apt install -y unzip
    - curl --location --output artifacts.zip "https://gitlab.example.com/api/v4/projects/1/jobs/artifacts/main/download?job=test&job_token=$CI_JOB_TOKEN"
    - unzip artifacts.zip

자산 아카이브의 내용 탐색

로컬로 자산을 다운로드하지 않고 UI에서 자산의 내용을 탐색할 수 있습니다. 다음 위치에서:

작업 목록. 작업 오른쪽에서 탐색을 선택하세요 ().
작업 상세 페이지. 페이지 오른쪽에서 탐색을 선택하세요.
자산 페이지. 작업 오른쪽에서 탐색을 선택하세요 ().

전역적으로 GitLab Pages가 활성화된 경우, 프로젝트 설정에서 비활성화되었더라도 브라우저에서 일부 자산 파일 확장명을 직접 미리 볼 수 있습니다. 프로젝트가 내부적이거나 비공개인 경우, 미리 보려면 GitLab Pages 액세스 제어를 활성화해야 합니다.

다음 확장명이 지원됩니다:

파일 확장명	GitLab.com	내장 NGINX가 포함된 Linux 패키지
`.html`	가능	가능
`.json`	가능	가능
`.xml`	가능	가능
`.txt`	불가능	가능
`.log`	불가능	가능

URL을 사용하여

공개적으로 접근 가능한 URL을 사용하여 특정 작업의 최신 성공한 파이프라인의 자산을 탐색할 수 있습니다.

예를 들어, GitLab.com의 프로젝트의 main 브랜치에 있는 build이라는 작업의 최신 자산을 탐색하려면:

https://gitlab.com/<full-project-path>/-/jobs/artifacts/main/browse?job=build

<full-project-path>를 프로젝트의 URL에서 확인할 수 있습니다.

작업 로그 및 자산 삭제

경고: 작업 로그와 자산을 삭제하면 되돌릴 수 없는 파괴적인 작업입니다. 신중하게 사용하세요. 보고서 자산, 작업 로그 및 메타데이터 파일을 포함하여 특정 파일을 삭제하면 해당 파일을 데이터 소스로 사용하는 GitLab 기능에 영향을 줍니다.

작업의 자산과 로그를 삭제할 수 있습니다.

사전 요구 사항:

해당 작업의 소유자이거나 프로젝트에 대해 최소한 Maintainer 역할을 가진 사용자여야 합니다.

작업을 삭제하려면:

작업 상세 페이지로 이동하세요.
작업 로그의 오른쪽 상단에서 작업 로그와 자산 지우기를 선택하세요 ({삭제}).

자산 페이지에서 개별 자산을 삭제할 수도 있습니다.

여러 자산을 일괄 삭제

GitLab 15.10에서 도입됨, 기본적으로 ci_job_artifact_bulk_destroy라는 플래그가 지정됨. 기본적으로 비활성화됨.
GitLab 16.1에 플래그가 제거됨.

동시에 여러 자산을 삭제할 수 있습니다:

왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾으세요.
빌드 > 자산을 선택하세요.
삭제하려는 자산 옆의 확인란을 선택하세요. 최대 50개의 자산을 선택할 수 있습니다.
선택 삭제를 선택하세요.

병합 요청 UI에서 작업 아티팩트로의 링크 걸기

artifacts:expose_as 키워드를 사용하여 병합 요청 UI에서 작업 아티팩트로의 링크를 표시합니다.

예를 들어, 단일 파일로 된 아티팩트의 경우:

test:
  script: ["echo 'test' > file.txt"]
  artifacts:
    expose_as: "artifact 1"
    paths: ["file.txt"]

위와 같은 구성으로 GitLab은 해당하는 병합 요청의 View exposed artifact 섹션에 artifact 1을 file.txt의 링크로 추가합니다.

가장 최근 성공한 작업으로부터 아티팩트 유지

차단이나 실패한 파이프라인의 아티팩트는 더 이상 무기한으로 유지되지 않습니다. 이 변경은 GitLab 16.7에서 이루어졌습니다.

기본적으로 각 ref의 가장 최근 커밋에 대해 성공한 파이프라인의 아티팩트는 항상 유지됩니다. 모든 expire_in 구성은 가장 최근 아티팩트에 적용되지 않습니다.

파이프라인의 아티팩트는 다음과 같은 경우에만 expire_in 구성에 따라 삭제됩니다:

성공.
실패.
수동 작업에 의한 차단으로 인해 실행 중지.

게다가, 최근 파이프라인이 아닌 경우에도 ref의 마지막 성공 파이프라인의 아티팩트는 유지됩니다. 결과적으로 새로운 파이프라인 실행이 실패하더라도, 마지막 성공 파이프라인의 아티팩트는 계속 유지됩니다.

가장 최근의 아티팩트 유지는 많은 작업 또는 큰 아티팩트가 있는 프로젝트에서 많은 저장 공간을 사용할 수 있습니다. 최근 아티팩트가 프로젝트에 필요 없는 경우, 이 동작을 비활성화하여 공간을 절약할 수 있습니다:

왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
설정 > CI/CD를 선택합니다.
Artifacts를 확장합니다.
가장 최근 성공한 작업으로부터 아티팩트 유지 확인란을 해제합니다.

이 설정을 비활성화한 후, 모든 새로운 아티팩트는 expire_in 구성에 따라 만료됩니다. 이전 파이프라인의 아티팩트는 같은 ref에 대해 새로운 파이프라인이 실행될 때까지 계속 유지됩니다. 그런 다음 해당 ref의 이전 파이프라인에서의 아티팩트도 만료됩니다.

자체 관리형 인스턴스에서 모든 프로젝트에 대해 이 동작을 비활성화할 수 있습니다. 인스턴스의 CI/CD 설정에서 최신 성공한 파이프라인의 모든 작업에 대한 최신 아티팩트 유지를 비활성화할 수 있습니다.

작업 아티팩트

작업 아티팩트 생성

와일드카드 사용

만료일 지정

동적으로 정의된 이름으로

Windows 러너 또는 쉘 실행기 사용 시

제외된 파일이 없을 때

추적되지 않는 파일 사용

작업에서 아티팩트 가져오지 않게 하기

프로젝트의 모든 작업 아티팩트 보기

작업 자산 다운로드

URL을 사용하여

CI/CD 작업 토큰을 사용하여

자산 아카이브의 내용 탐색

URL을 사용하여

작업 로그 및 자산 삭제

여러 자산을 일괄 삭제

병합 요청 UI에서 작업 아티팩트로의 링크 걸기

가장 최근 성공한 작업으로부터 아티팩트 유지

도움말

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

도움받기