작업 아티팩트

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

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

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

작업 아티팩트에 대한 개요를 보려면 GitLab CI 파이프라인, 아티패트 및 환경 동영상을 시청하세요. 또는 초보자를 위한 GitLab CI 파이프라인 튜토리얼을 시청하세요.

작업 아티팩트 저장에 대한 관리자 정보는 작업 아티팩트 관리를 참조하십시오.

작업 아티팩트 생성

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

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

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

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

와일드카드 사용

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

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

만료 시간 설정

expire_in 키워드는 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/에 있는 모든 파일을 저장하지만 서브디렉터리에 있는 *.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/

예를 들어, 추적되지 않는 파일의 모든 파일을 저장하지만 artifacts:exclude를 사용하여 *.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: 키워드로 생성된 아티팩트.
보고서 아티팩트.
내부적으로 별도의 아티팩트로 저장된 작업 로그 및 메타데이터.

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

작업 아티팩트 다운로드

다음의 위치에서 작업 아티팩트를 다운로드할 수 있습니다:

Pipelines 디렉터리의 오른쪽에서 아티팩트 다운로드()를 선택합니다.
Jobs 디렉터리의 오른쪽에서 아티팩트 다운로드()를 선택합니다.
작업 상세 페이지에서 페이지 오른쪽에서 다운로드를 선택합니다.
Merge Request 개요 페이지에서 최신 파이프라인의 오른쪽에서 아티팩트()를 선택합니다.
아티팩트 페이지에서 작업의 오른쪽에서 다운로드()를 선택합니다.
아티팩트 브라우저에서 페이지 상단에서 아티팩트 아카이브 다운로드()를 선택합니다.

보고서 아티팩트는 Pipelines 디렉터리이나 아티팩트 페이지에서만 다운로드할 수 있습니다.

[최근 성공한 파이프라인에서 작업 아티팩트를 다운로드할 수 있습니다. 작업 아티팩트 API를 사용하여 해당 내용을 확인할 수 있습니다. 작업 아티팩트 API를 사용하여 보고서 아티팩트를 다운로드할 수는 없지만, 보고서가 artifacts:paths로 정상 아티팩트로 추가된 경우에는 다운로드할 수 있습니다.

URL을 통해

특정 작업에 대한 아티팩트 아카이브를 다운로드할 수 있습니다. 이는 공개적으로 접근 가능한 작업 아티팩트 API의 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: Premium, Ultimate 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에서 아티팩트의 내용을 찾을 수 있습니다.

Jobs 디렉터리 어디에서나. 작업 오른쪽에서 Browse ()를 선택합니다.
작업 상세 페이지. 페이지 오른쪽에서 Browse를 선택합니다.
Artifacts 페이지. 작업 오른쪽에서 Browse ()를 선택합니다.

프로젝트에서 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 역할 이상의 사용자여야 합니다.

작업을 삭제하려면:

작업 상세 페이지로 이동합니다.
작업 로그 오른쪽 상단에서 Erase job log and artifacts ()를 선택합니다.

또는 아티팩트 페이지에서 개별적인 아티팩트를 삭제할 수도 있습니다.

아티팩트 일괄 삭제

GitLab 15.10에서 도입. 기본적으로 비활성화되어 있습니다. 피처 플래그ci_job_artifact_bulk_destroy로 제어됩니다.
GitLab 16.1에서 피처 플래그가 제거되었습니다.

동시에 여러 아티팩트를 삭제할 수 있습니다:

왼쪽 사이드바에서 Search or go to를 선택하여 프로젝트를 찾습니다.
Build > Artifacts를 선택합니다.
삭제할 아티팩트 옆의 확인란을 선택합니다. 최대 50개의 아티팩트를 선택할 수 있습니다.
Delete selected를 선택합니다.

Merge Request UI에서 작업 아티팩트로 연결

artifacts:expose_as 키워드를 사용하여 Merge Request UI에서 작업 아티팩트로의 링크를 표시할 수 있습니다.

예를 들어, 단일 파일을 포함하는 아티팩트를 위해:

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

이 구성으로 인해 GitLab은 관련 Merge Request의 View exposed artifact 섹션에 file.txt에 대한 artifact 1 링크를 추가합니다.

가장 최근 성공적인 작업에서의 아티팩트 보존

GitLab 16.7에서 blocked 또는 failed 파이프라인의 아티팩트는 더 이상 무기한으로 유지되지 않습니다.

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

파이프라인의 아티팩트는:

성공적으로 완료되거나
실패하거나
매뉴얼 작업에 의해 차단되어 중지될 경우

동일한 ref에 대해 새로운 파이프라인이 실행될 때 expire_in 구성에 따라 삭제됩니다. 또한, 가장 최근 파이프라인이 아니더라도 ref의 마지막 성공 파이프라인의 아티팩트는 보존됩니다. 결과적으로 새로운 파이프라인 실행이 실패하더라도, 마지막 성공 파이프라인의 아티팩트는 계속 유지됩니다.

많은 작업 또는 대용량 아티팩트를 가진 프로젝트의 저장 공간을 많이 차지할 수 있습니다. 최신 아티팩트가 프로젝트에 필요하지 않은 경우 공간을 절약하기 위해 이 동작을 비활성화할 수 있습니다:

왼쪽 사이드바에서 Search or go to를 선택하여 프로젝트를 찾습니다.
Settings > CI/CD를 선택합니다.
Artifacts를 확장합니다.
Keep artifacts from most recent successful jobs 확인란을 지웁니다.

이 설정을 비활성화한 후, 모든 새로운 아티팩트는 expire_in 구성에 따라 만료됩니다. 구멍 파이프라인의 아티팩트는 동일한 ref에 대해 새로운 파이프라인이 실행될 때까지 계속해서 보존됩니다. 그러나 해당 ref의 이전 파이프라인의 아티팩트는 만료됩니다.

이 동작을 Self-Managed형되는 인스턴스의 모든 프로젝트에 대해 비활성화할 수 있습니다. 인스턴스의 CI/CD 설정에서 자세한 내용을 확인하세요.

작업 아티팩트

작업 아티팩트 생성

와일드카드 사용

만료 시간 설정

동적으로 정의된 이름으로

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

제외 파일 포함

추적되지 않는 파일 포함

작업이 아티팩트를 가져오지 않도록 방지

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

작업 아티팩트 다운로드

URL을 통해

CI/CD 작업 토큰으로

아티팩트 아카이브의 내용 탐색

URL을 통해

작업 로그 및 아티팩트 삭제

아티팩트 일괄 삭제

Merge Request UI에서 작업 아티팩트로 연결

가장 최근 성공적인 작업에서의 아티팩트 보존

도움말

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

도움받기