GitLab CI/CD 아티팩트 보고서 유형

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

artifacts:reports를 사용하여 다음을 수행할 수 있습니다:

  • 작업에서 생성된 포함된 템플릿에서 생성된 테스트 보고서, 코드 품질 보고서, 보안 보고서 및 기타 아티팩트를 수집합니다.
  • 이러한 보고서 중 일부는 다음에서 정보를 표시하는 데 사용됩니다:

artifacts:보고서에서 생성된 아티팩트는 작업 결과 (성공 또는 실패)에 관계없이 항상 업로드됩니다. 아티팩트의 만료 시간을 설정하려면 artifacts:expire_in을 사용하여 인스턴스의 기본 설정을 재정의할 수 있습니다. GitLab.com은 다른 기본 아티팩트 만료 값을 가질 수 있습니다.

일부 artifacts:보고서 유형은 동일한 파이프라인의 여러 작업에서 생성될 수 있으며, 각 작업의 Merge Request 또는 파이프라인 기능에서 사용될 수 있습니다.

보고서 출력 파일을 탐색하려면 작업 정의에 artifacts:paths 키워드를 포함해야 합니다.

노트: 자식 파이프라인에서 아티팩트 사용하여 상위 파이프라인에 결합된 보고서는 지원되지 않습니다. 이에 대한 지원 추가 진행 상황은 이 이슈에서 추적하십시오.

artifacts:reports:accessibility

accessibility 보고서는 Merge Request에서 도입된 변경 사항의 접근성 영향을 보고하기 위해 pa11y를 사용합니다.

GitLab은 Merge Request의 접근성 위젯에서 하나 이상의 보고서 결과를 표시할 수 있습니다. 자세한 정보는 접근성 테스트를 참조하십시오.

artifacts:reports:annotations

annotations 보고서는 작업에 보조 데이터를 첨부하는 데 사용됩니다.

주석 보고서는 주석 섹션을 갖는 JSON 파일입니다. 각 주석 섹션은 원하는 이름을 가질 수 있으며 같은 타입 또는 다른 타입의 주석을 여러 개 가질 수 있습니다.

각 주석은 작업 출력 페이지에 링크를 추가하는 데 사용할 수 있는 external_link 주석입니다. external_link 주석의 값은 다음과 같은 키를 가진 객체입니다:

키 설명
label 링크와 연결된 사람이 읽을 수 있는 레이블입니다.
url 링크가 가리키는 URL입니다.

보고서 예시

다음은 작업 주석 보고서의 예시입니다: 

{
  "my_annotation_section_1": [
    {
      "external_link": {
        "label": "URL 1",
        "url": "https://url1.example.com/"
      }
    },
    {
      "external_link": {
        "label": "URL 2",
        "url": "https://url2.example.com/"
      }
    }
  ]
}

artifacts:reports:api_fuzzing

Tier: Ultimate

api_fuzzing 보고서는 API Fuzzing 버그를 아티팩트로 수집합니다.

GitLab은 Merge Request 보안 위젯, 프로젝트 취약점 보고서, 파이프라인 보안 탭, 보안 대시보드에서 하나 이상의 보고서 결과를 표시할 수 있습니다.

artifacts:reports:browser_performance

Tier: Premium, Ultimate

browser_performance 보고서는 브라우저 성능 테스트 지표를 아티팩트로 수집합니다. 이 아티팩트는 Sitespeed 플러그인에 의해 출력된 JSON 파일입니다.

GitLab은 Merge Request 브라우저 성능 테스트 위젯에서 하나의 보고서 결과를 표시할 수 있습니다. GitLab은 여러 browser_performance 보고서의 결합된 결과를 표시할 수 없습니다.

artifacts:reports:coverage_report

coverage_report를 사용하여 Cobertura 형식의 커버리지 보고서를 수집합니다.

cobertura 보고서는 Cobertura 커버리지 XML 파일을 수집합니다.

Cobertura는 원래 Java용으로 개발되었지만 JavaScript, Python 및 Ruby와 같은 다른 언어의 여러 타사 포트가 있습니다. 

artifacts:
  reports:
    coverage_report:
      coverage_format: cobertura
      path: coverage/cobertura-coverage.xml

수집된 커버리지 보고서는 GitLab에 아티팩트로 업로드됩니다. 한 작업 당 하나의 보고서만 사용할 수 있습니다.

GitLab은 Merge Request 차이 주석에서 커버리지 보고서 결과를 표시할 수 있습니다.

artifacts:reports:codequality

  • 다중 보고서 지원: 15.7에서 도입.

codequality 보고서는 코드 품질 문제를 수집합니다. 수집된 코드 품질 보고서는 GitLab에 아티팩트로 업로드됩니다.

GitLab은 Merge Request 코드 품질 위젯, Merge Request 차이 주석, 전체 보고서에 하나 이상의 보고서 결과를 표시할 수 있습니다.

artifacts:expire_in 값은 1주로 설정되어 있습니다.

artifacts:reports:container_scanning

Tier: Ultimate

container_scanning 보고서는 컨테이너 스캐닝 취약점을 수집합니다. 수집된 컨테이너 스캐닝 보고서는 GitLab에 아티팩트로 업로드됩니다.

GitLab은 Merge Request 컨테이너 스캐닝 위젯, 파이프라인 보안 탭, 보안 대시보드, 프로젝트 취약점 보고서에 하나 이상의 보고서 결과를 표시할 수 있습니다.

artifacts:reports:coverage_fuzzing

Tier: Ultimate

coverage_fuzzing 보고서는 커버리지 퍼징 버그를 수집합니다. 수집된 커버리지 퍼징 보고서는 GitLab에 아티팩트로 업로드됩니다.

GitLab은 Merge Request 커버리지 퍼징 위젯, 파이프라인 보안 탭, 보안 대시보드, 프로젝트 취약점 보고서에 하나 이상의 보고서 결과를 표시할 수 있습니다.

artifacts:reports:cyclonedx

Tier: Ultimate
History

이 보고서는 프로젝트의 컴포넌트를 설명하는 소프트웨어 원료 디렉터리(BOM)으로, CycloneDX 프로토콜 형식을 따릅니다.

작업 당 여러 CycloneDX 보고서를 지정할 수 있습니다. 이들은 파일 이름 디렉터리, 파일 이름 패턴 또는 둘 다로 제공할 수 있습니다.

  • 파일 이름 패턴(cyclonedx: gl-sbom-*.json, junit: test-results/**/*.json).
  • 파일 이름의 배열(cyclonedx: [gl-sbom-npm-npm.cdx.json, gl-sbom-bundler-gem.cdx.json]).
  • 둘 다를 결합(cyclonedx: [gl-sbom-*.json, my-cyclonedx.json]).
  • 디렉터리는 지원되지 않습니다(cyclonedx: test-results, cyclonedx: test-results/**).

아래는 CycloneDX 보고서를 노출하는 작업의 예시입니다: 

artifacts:
  reports:
    cyclonedx:
      - gl-sbom-npm-npm.cdx.json
      - gl-sbom-bundler-gem.cdx.json

artifacts:reports:dast

Tier: Ultimate

dast 보고서는 DAST 취약점을 수집합니다. 수집된 DAST 보고서는 artifact로 GitLab에 업로드됩니다.

GitLab은 하나 이상의 보고서 결과를 다음에서 표시할 수 있습니다:

artifacts:reports:dependency_scanning

Tier: Ultimate

dependency_scanning 보고서는 의존성 스캐닝 취약점을 수집합니다. 수집된 의존성 스캐닝 보고서는 artifact로 GitLab에 업로드됩니다.

GitLab은 하나 이상의 보고서 결과를 다음에서 표시할 수 있습니다:

artifacts:reports:dotenv

dotenv 보고서는 환경 변수 세트를 artifact로 수집합니다.

수집된 변수는 작업의 런타임에서 생성된 변수로 등록되어 작업 완료 후 동적 환경 URL 설정에 사용할 수 있습니다.

.env 보고서에 중복 환경 변수가 있는 경우 나중에 지정된 환경 변수가 사용됩니다.

보안 정보 등 민감한 데이터를 dotenv 보고서에 저장하는 것은 피해야 합니다. 보고서는 파이프라인 세부 정보 페이지에서 다운로드할 수 있기 때문입니다. 필요한 경우 artifacts:access를 사용하여 작업에서 다운로드할 수 있는 보고서 artifact를 제한할 수 있습니다.

원본 dotenv 규칙의 예외는 다음과 같습니다:

  • 변수 키에는 문자, 숫자 및 밑줄(_)만 포함될 수 있습니다.
  • .env 파일의 최대 크기는 5 KB입니다. 이 한계는 Self-Managed형 인스턴스에서 변경할 수 있습니다.
  • GitLab.com에서 상속된 변수의 최대 수는 Free가 50개, Premium이 100개, Ultimate가 150개입니다. Self-Managed형 인스턴스의 기본값은 150이며, dotenv_variables 애플리케이션 한도를 변경하여 변경할 수 있습니다.
  • .env 파일의 변수 치환은 지원되지 않습니다.
  • .env 파일의 여러 줄 값은 지원되지 않습니다.
  • .env 파일에는 빈 줄이나 #로 시작하는 주석이 없어야 합니다.
  • env 파일의 키 값에는 공백이나 개행 문자(\n)가 없어야 합니다. 따옴표를 사용하거나 사용하지 않더라도 유효합니다.
  • 구문 분석 중 따옴표 이스케이프(key = 'value' -> {key: "value"})는 지원되지 않습니다.
  • UTF-8 인코딩만 지원됩니다.

artifacts:reports:junit

junit 보고서는 JUnit 보고 형식 XML 파일을 수집합니다. 수집된 단위 테스트 보고서는 artifact로 GitLab에 업로드됩니다. JUnit은 원래 Java에서 개발되었지만 JavaScript, Python, Ruby 등 다른 언어로의 제 3자 이식본이 많이 있습니다.

더 많은 세부 정보와 예시는 단위 테스트 보고서를 참조하세요. 아래는 Ruby의 RSpec 테스트 도구에서 JUnit 보고 형식 XML 파일을 수집하는 예시입니다: 

rspec:
  stage: test
  script:
    - bundle install
    - rspec --format RspecJunitFormatter --out rspec.xml
  artifacts:
    reports:
      junit: rspec.xml

GitLab은 하나 이상의 보고서 결과를 다음에서 표시할 수 있습니다:

일부 JUnit 도구는 여러 XML 파일로 내보내기합니다. 단일 작업에서 여러 테스트 보고 경로를 지정하여 하나의 파일로 연결할 수 있습니다. 다음 중 하나를 사용하세요:

  • 파일 이름 패턴(junit: rspec-*.xml, junit: test-results/**/*.xml).
  • 파일 이름의 배열(junit: [rspec-1.xml, rspec-2.xml, rspec-3.xml]).
  • 둘 다를 결합(junit: [rspec.xml, test-results/TEST-*.xml]).
  • 디렉터리는 지원되지 않습니다(junit: test-results, junit: test-results/**).

artifacts:reports:load_performance

Tier: Premium, Ultimate

load_performance 보고서는 로드 수행 테스트 지표를 수집합니다. 보고서는 artifact로 GitLab에 업로드됩니다.

GitLab은 Merge Request 로드 테스트 위젯에서 하나의 보고서 결과만 표시할 수 있습니다.

GitLab은 여러 load_performance 보고서의 결합 결과를 표시할 수 없습니다.

artifacts:reports:metrics

Tier: Premium, Ultimate

metrics 보고서는 메트릭을 수집합니다. 수집된 메트릭 보고서는 artifact로 GitLab에 업로드됩니다.

GitLab은 Merge Request 메트릭 보고서 위젯에서 하나 이상의 보고서 결과를 표시할 수 있습니다.

artifacts:reports:requirements

Tier: Ultimate

requirements 보고서는 requirements.json 파일을 수집합니다. 수집된 요구 사항 보고서는 artifact로 GitLab에 업로드됩니다. 기존 요구 사항은 만족됩니다.

GitLab은 프로젝트 요구 사항에서 하나 이상의 보고서 결과를 표시할 수 있습니다.

artifacts:reports:repository_xray

Tier: Ultimate
History

repository_xray 보고서는 AI가 코드 제안에 사용할 리포지터리에 대한 정보를 수집합니다.

artifacts:reports:sast

History
  • Moved from GitLab Ultimate to GitLab Free in 13.3.

sast 보고서는 SAST 취약점을 수집합니다. 수집된 SAST 보고서는 GitLab에 아티팩트로 업로드됩니다.

자세한 내용은 다음을 참조하십시오:

artifacts:reports:secret_detection

secret-detection 보고서는 검출된 비밀을 수집합니다. 수집된 Secret Detection 보고서는 GitLab에 업로드됩니다.

GitLab은 하나 이상의 보고서 결과를 다음에서 표시할 수 있습니다:

artifacts:reports:terraform

terraform 보고서는 Terraform tfplan.json 파일을 얻습니다. 자격 증명을 제거하려면 JQ 처리가 필요합니다. 수집된 Terraform plan 보고서는 GitLab에 아티팩트로 업로드됩니다.

GitLab은 하나 이상의 보고서 결과를 Merge Request에 Terraform 위젯에서 표시할 수 있습니다.

자세한 내용은 Merge Request으로 terraform plan 정보 출력을 참조하십시오.