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

세부 정보: Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

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

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

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

동일 파이프라인의 여러 작업에서 생성된 일부 artifacts:reports 유형은 각 작업에서 병합 요청이나 파이프라인 기능에 의해 사용될 수 있습니다.

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

참고: 부모 파이프라인의 결합된 보고서는 자식 파이프라인에서 가져온 아티팩트를 사용하여 지원되지 않습니다. 지원 추가에 대한 진행 상황은 이 이슈를 추적하세요.

artifacts:reports:accessibility

accessibility 보고서는 pa11y를 사용하여 병합 요청에서 도입된 변경 사항에 대한 접근성 영향을 보고합니다.

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

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 Offering: GitLab.com, Self-managed, GitLab Dedicated

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

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

artifacts:reports:browser_performance

세부 정보: Tier: Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

GitLab 14.0에서 artifacts:reports:performance에서 이름이 변경되었습니다.

browser_performance 보고서는 브라우저 성능 테스트 지표를 아티팩트로 수집합니다.

GitLab은 병합 요청 브라우저 성능 테스트 위젯에서 하나의 보고서 결과를 표시할 수 있습니다.

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은 병합 요청 차이 주석에서 커버리지 보고서 결과를 표시할 수 있습니다.

artifacts:reports:codequality

  • 다중 보고서 지원이 병합 요청 코드 품질 위젯 및 전체 파이프라인 보고서에서 15.7에서 소개되었습니다.

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

GitLab은 한 개 이상의 보고서 결과를 표시할 수 있습니다:

artifacts:expire_in 값은 1주일로 설정됩니다.

artifacts:reports:container_scanning

Tier: Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

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

GitLab은 한 개 이상의 보고서 결과를 표시할 수 있습니다:

artifacts:reports:coverage_fuzzing

Tier: Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

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

GitLab은 한 개 이상의 보고서 결과를 표시할 수 있습니다:

artifacts:reports:cyclonedx

이 보고서는 프로젝트의 구성 요소를 설명하는 소프트웨어 부품 목록서로, 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 Offering: GitLab.com, Self-managed, GitLab Dedicated

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

GitLab은 한 개 이상의 보고서 결과를 표시할 수 있습니다:

artifacts:reports:dependency_scanning

Tier: Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

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

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

artifacts:reports:dotenv

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

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

.env 보고서에 중복된 환경 변수가 있는 경우:

  • GitLab 14.6 이상에서는 마지막으로 지정된 환경 변수가 사용됩니다.
  • GitLab 14.5 이하에서는 오류가 발생합니다.

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

artifacts:reports:junit

junit 보고서는 JUnit 보고서 형식 XML 파일을 수집합니다. 수집된 단위 테스트 보고서는 GitLab에 artifact로 업로드됩니다. JUnit은 원래 Java에서 개발되었지만 JavaScript, Python, Ruby와 같은 다른 언어용 많은 타사 포트가 있습니다.

자세한 내용 및 예제는 단위 테스트 보고서를 참조하십시오. 아래는 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 Offering: GitLab.com, Self-managed, GitLab Dedicated

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

GitLab은 병합 요청의 부하 테스트 위젯에서 하나의 보고서 결과만 표시할 수 있습니다.

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

artifacts:reports:metrics

자세한 내용: Tier: Premium, Ultimate Offering: GitLab.com, Self-Managed, GitLab Dedicated

metrics 보고서는 Metrics를 수집합니다. 수집된 Metrics 보고서는 artifact로 GitLab에 업로드됩니다.

GitLab은 병합 요청 metrics 보고서 위젯에서 하나 이상의 보고서 결과를 표시할 수 있습니다.

artifacts:reports:requirements

자세한 내용: Tier: Ultimate Offering: GitLab.com, Self-Managed, GitLab Dedicated

requirements 보고서는 requirements.json 파일을 수집합니다. 수집된 Requirements 보고서는 artifact로 GitLab에 업로드되고 기존 requirements는 만족한 것으로 표시됩니다.

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

artifacts:reports:repository_xray

자세한 내용: Tier: Ultimate Offering: GitLab.com, Self-Managed, GitLab Dedicated

repository_xray 보고서는 리포지토리에 대한 정보를 수집하여 코드 제안에서 AI가 활용합니다.

artifacts:reports:sast

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

자세한 내용은 다음을 참조하세요:

artifacts:reports:secret_detection

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

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

artifacts:reports:terraform

terraform 보고서는 Terraform tfplan.json 파일을 얻습니다. 자격 증명 제거를 위해 JQ 처리가 필요. 수집된 Terraform plan 보고서는 artifact로 GitLab에 업로드됩니다.

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

자세한 내용은 병합 요청으로 terraform plan 정보 출력을 참조하세요.