'GitHub Actions' 작업 YAML

포커스 모드

'GitHub Actions' 작업 YAML - Amazon CodeCatalyst

다음은 GitHub Actions 작업의 YAML 정의입니다.

이 작업 정의는 더 광범위한 워크플로 정의 파일 내의 섹션으로 존재합니다. 이 파일에 대한 자세한 내용은 워크플로 YAML 정의을 참조합니다.

다음 코드에서 YAML 속성을 선택하면 설명이 표시됩니다.

참고

이어지는 대부분의 YAML 속성에는 시각적 편집기에 해당 UI 요소가 있습니다. UI 요소를 찾으려면 Ctrl+F를 사용합니다. 요소가 연결된 YAML 속성과 함께 나열됩니다.


# The workflow definition starts here.
# See 최상위 속성 for details.
        
Name: MyWorkflow
SchemaVersion: 1.0 
Actions:

# The action definition starts here.
  action-name:
    Identifier:  aws/github-actions-runner@v1
    DependsOn:
      - dependent-action-name-1
    Compute:
      Fleet: fleet-name
    Timeout: timeout-minutes
    Environment:
      Name: environment-name
      Connections:
        - Name: account-connection-name
          Role: iam-role-name
    Inputs:
      Sources:
        - source-name-1
        - source-name-2
      Artifacts:
        - artifact-name
      Variables:
        - Name: variable-name-1
          Value: variable-value-1
        - Name: variable-name-2
          Value: variable-value-2   
    Outputs:
      Artifacts:
        - Name: output-artifact-1
          Files: 
            - github-output/artifact-1.jar
            - "github-output/build*"
        - Name: output-artifact-2
          Files:
            - github-output/artifact-2.1.jar
            - github-output/artifact-2.2.jar
      Variables:
        - variable-name-1
        - variable-name-2
      AutoDiscoverReports:
        Enabled: true | false
        ReportNamePrefix: AutoDiscovered
        IncludePaths:
          - "**/*"
        ExcludePaths:
          - node_modules/cdk/junit.xml
        SuccessCriteria:
          PassRate: percent
          LineCoverage: percent
          BranchCoverage: percent
          Vulnerabilities:
            Severity: CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL
            Number: whole-number
      Reports:
        report-name-1:
          Format: format
          IncludePaths:
            - "*.xml"
          ExcludePaths:
            - report2.xml
            - report3.xml
          SuccessCriteria:
            PassRate: percent
            LineCoverage: percent
            BranchCoverage: percent
            Vulnerabilities:
              Severity: CRITICAL|HIGH|MEDIUM|LOW|INFORMATIONAL
              Number: whole-number
    Configuration      
      Steps:
        - github-actions-code

action-name

(필수)

작업 이름을 지정합니다. 워크플로 내의 모든 작업 이름은 고유해야 합니다. 작업 이름은 영숫자 문자(a-z, A-Z, 0-9), 하이픈(-) 및 밑줄(_)로 제한됩니다. 스페이스은 허용되지 않습니다. 작업 이름에서 특수 문자와 공백을 활성화하는 데 따옴표를 사용할 수 없습니다.

해당 UI: 구성 탭/action-name

Identifier

(action-name/Identifier)

작업을 식별합니다. 버전을 변경하려는 경우가 아니면 이 속성을 변경하지 마세요. 자세한 내용은 사용할 작업 버전 지정 섹션을 참조하세요.

aws/github-actions-runner@v1를 GitHub Actions 작업에 사용합니다.

해당 UI: 워크플로 다이어그램/action-name /aws/github-actions-runner@v1 레이블

DependsOn

(action-name/DependsOn)

(선택 사항)

이 작업을 실행하기 위해 성공적으로 실행해야 하는 작업, 작업 그룹 또는 게이트를 지정합니다.

'depends on' 함수에 대한 자세한 내용은 작업 순서 지정 섹션을 참조하세요.

해당 UI: 입력 탭/의존 - 선택 사항

Compute

(action-name/Compute)

(선택 사항)

워크플로 작업을 실행하는 데 사용되는 컴퓨팅 엔진입니다. 워크플로 수준 또는 작업 수준에서 컴퓨팅을 지정할 수 있지만 둘 다 지정할 수는 없습니다. 워크플로 수준에서 지정하면 컴퓨팅 구성이 워크플로에 정의된 모든 작업에 적용됩니다. 워크플로 수준에서는 동일한 인스턴스에서 여러 작업을 실행할 수도 있습니다. 자세한 내용은 작업 간에 컴퓨팅 공유 섹션을 참조하세요.

해당 UI: 없음

Fleet

(action-name/Compute/Fleet)

(선택 사항)

워크플로 또는 워크플로 작업을 실행할 시스템 또는 플릿을 지정합니다. 온디맨드 플릿의 경우 작업이 시작되면 워크플로가 필요한 리소스를 프로비저닝하고 작업이 완료되면 시스템이 파괴됩니다. 온디맨드 플릿의 예시: Linux.x86-64.Large, Linux.x86-64.XLarge. 온디맨드 플릿에 대한 자세한 내용은 온디맨드 플릿 속성 섹션을 참조하세요.

프로비저닝된 플릿을 사용하면 워크플로 작업을 실행하도록 전용 시스템 세트를 구성할 수 있습니다. 이러한 시스템은 유휴 상태로 유지되므로 작업을 즉시 처리할 수 있습니다. 프로비저닝된 플릿에 대한 자세한 내용은 프로비저닝된 플릿 속성 섹션을 참조하세요.

Fleet 생략 시 기본값은 Linux.x86-64.Large입니다.

해당 UI: 구성 탭/컴퓨팅 플릿 - 선택 사항

Timeout

(action-name/Timeout)

(선택 사항)

CodeCatalyst가 작업을 종료하기 전에 작업을 실행할 수 있는 시간을 분(YAML 편집기) 또는 시간 및 분(시각적 편집기) 단위로 지정합니다. 최소값은 5분이고 최대값은 CodeCatalyst의 워크플로 할당량에 설명되어 있습니다. 기본 제한 시간은 최대 제한 시간과 동일합니다.

해당 UI: 구성 탭/제한 시간 - 선택 사항

Environment

(action-name/Environment)

(선택 사항)

작업에 사용할 CodeCatalyst 환경을 지정합니다. 작업은 선택한 환경에 지정된 AWS 계정 및 선택적 Amazon VPC에 연결됩니다. 작업은 환경에 지정된 기본 IAM 역할을 사용하여에 연결하고 Amazon VPC 연결에 지정된 IAM 역할을 AWS 계정사용하여 Amazon VPC에 연결합니다.

참고

기본 IAM 역할에 작업에 필요한 권한이 없는 경우 다른 역할을 사용하도록 작업을 구성할 수 있습니다. 자세한 내용은 작업의 IAM 역할 변경 섹션을 참조하세요.

환경에 대한 자세한 내용은 AWS 계정 및 VPCs에 배포 및 환경 생성 섹션을 참조하세요.

해당 UI: 구성 탭/환경

Name

(action-name/Environment/Name)

(Environment 포함 시 필수)

작업과 연결하려는 기존 환경의 이름을 지정합니다.

해당 UI: 구성 탭/환경

Connections

(action-name/Environment/Connections)

(선택 사항)

작업과 연결할 계정 연결을 지정합니다. Environment에서 계정 연결을 최대 1개까지 지정할 수 있습니다.

계정 연결을 지정하지 않는 경우:

작업은 CodeCatalyst 콘솔의 환경에 지정된 AWS 계정 연결 및 기본 IAM 역할을 사용합니다. 환경에 계정 연결 및 기본 IAM 역할을 추가하는 방법에 대한 자세한 내용은 환경 생성 섹션을 참조하세요.
기본 IAM 역할에는 작업에 필요한 정책 및 권한이 포함되어야 합니다. 이러한 정책 및 권한이 무엇인지 확인하려면 작업의 YAML 정의 설명서에서 역할 속성에 대한 설명을 참조하세요.

계정 연결에 대한 자세한 정보는 연결된 AWS 리소스에 대한 액세스 허용 AWS 계정 섹션을 참조하세요. 환경에 계정 연결을 추가하는 방법에 대한 자세한 내용은 환경 생성 섹션을 참조하세요.

해당 UI: 구성 탭/환경/내 환경의 내용/점 3개 메뉴/역할 전환

Name

(action-name/Environment/Connections/Name)

(Connections 포함 시 필수)

계정 연결의 이름을 지정합니다.

해당 UI: 구성 탭/환경/내 환경의 내용/점 3개 메뉴/역할 전환

Role

(action-name/Environment/Connections/Role)

(Connections 포함 시 필수)

Amazon S3 및 Amazon ECR과 같은 AWS 서비스에 액세스하고 운영하기 위해 이 작업이 사용하는 IAM 역할의 이름을 지정합니다. 이 역할이 스페이스의 AWS 계정 연결에 추가되었는지 확인합니다. 계정 연결에 IAM 역할을 추가하려면 계정 연결에 IAM 역할 추가 섹션을 참조하세요.

IAM 역할을 지정하지 않으면 작업은 CodeCatalyst 콘솔의 환경에 나열된 기본 IAM 역할을 사용합니다. 환경에서 기본 역할을 사용하는 경우 다음 정책이 있는지 확인합니다.

참고

이 작업에서 CodeCatalystWorkflowDevelopmentRole-spaceName 역할을 사용할 수 있습니다. 이에 대한 자세한 내용은 계정 및 스페이스의 CodeCatalystWorkflowDevelopmentRole-spaceName 역할 생성 섹션을 참조하세요. CodeCatalystWorkflowDevelopmentRole-spaceName 역할에 보안 위험을 초래할 수 있는 전체 액세스 권한이 있음을 이해합니다. 보안에 대한 우려가 적은 자습서 및 시나리오에서만 이 역할을 사용하는 것이 좋습니다.

주의

권한을 GitHub 작업 작업에 필요한 권한으로 제한합니다. 더 광범위한 권한을 가진 역할을 사용하면 보안 위험이 발생할 수 있습니다.

해당 UI: 구성 탭/환경/내 환경의 내용/점 3개 메뉴/역할 전환

Inputs

(action-name/Inputs)

(선택 사항)

이 Inputs 섹션에서는 워크플로 실행 중에 작업에 필요한 데이터를 정의합니다.

참고

GitHub Actions 작업당 최대 4개의 입력(소스 1개 및 아티팩트 3개)이 허용됩니다. 변수는 이 합계에 포함되지 않습니다.

서로 다른 입력(소스 및 아티팩트)에 있는 파일을 참조해야 하는 경우 소스 입력은 기본 입력이고 아티팩트는 보조 입력입니다. 보조 입력의 파일에 대한 참조는 특수 접두사를 사용하여 기본 입력에서 파일을 구분합니다. 세부 정보는 예시: 여러 아티팩트에서 파일 참조을 참조하세요.

해당 UI: 입력 탭

Sources

(action-name/Inputs/Sources)

(선택 사항)

작업에 필요한 소스 리포지토리를 나타내는 레이블을 지정합니다. 현재 지원되는 유일한 레이블은 워크플로 정의 파일이 저장되는 소스 리포지토리를 나타내는 WorkflowSource입니다.

소스를 생략하는 경우 action-name/Inputs/Artifacts 아래에 하나 이상의 입력 아티팩트를 지정해야 합니다.

소스에 대한 자세한 내용은 워크플로에 소스 리포지토리 연결 섹션을 참조하세요.

해당 UI: 입력 탭/소스 - 선택 사항

Artifacts - input

(action-name/Inputs/Artifacts)

(선택 사항)

이 작업에 대한 입력으로 제공하려는 이전 작업의 아티팩트를 지정합니다. 이러한 아티팩트는 이전 작업에서 출력 아티팩트로 이미 정의되어 있어야 합니다.

입력 아티팩트를 지정하지 않으면 action-name/Inputs/Sources 아래에 소스 리포지토리를 하나 이상 지정해야 합니다.

예시를 포함해 아티팩트에 대한 자세한 내용은 작업 간 아티팩트 및 파일 공유 섹션을 참조하세요.

참고

아티팩트 - 선택적 드롭다운 목록을 사용할 수 없거나(시각적 편집기) YAML(YAML 편집기)을 검증할 때 오류가 발생하는 경우 작업이 하나의 입력만 지원하기 때문일 수 있습니다. 이 경우 소스 입력을 제거해 보세요.

해당 UI: 입력 탭/아티팩트 - 선택 사항

Variables - input

(action-name/Inputs/Variables)

(선택 사항)

작업에 사용할 수 있도록 하려는 입력 변수를 정의하는 이름/값 페어의 시퀀스를 지정합니다. 변수 이름은 영숫자 문자(a-z, A-Z, 0-9), 하이픈(-) 및 밑줄(_)로 제한됩니다. 스페이스은 허용되지 않습니다. 변수 이름에서 특수 문자와 공백을 활성화하는 데 따옴표를 사용할 수 없습니다.

예시를 비롯한 변수에 대한 자세한 내용은 워크플로에서 변수 사용 섹션을 참조하세요.

해당 UI: 입력 탭/변수 - 선택 사항

Outputs

(action-name/Outputs)

(선택 사항)

워크플로 실행 중에 작업에 의해 출력되는 데이터를 정의합니다.

해당 UI: 출력 탭

Artifacts - output

(action-name/Outputs/Artifacts)

(선택 사항)

작업에서 생성된 아티팩트의 이름을 지정합니다. 아티팩트 이름은 워크플로 내에서 고유해야 하며 영숫자 문자(a-z, A-Z, 0-9) 및 밑줄(_)로 제한됩니다. 공백, 하이픈(-) 및 특수 문자는 허용되지 않습니다. 출력 아티팩트 이름에서 공백, 하이픈 및 기타 특수 문자를 활성화하는 데 따옴표를 사용할 수 없습니다.

예시를 포함해 아티팩트에 대한 자세한 내용은 작업 간 아티팩트 및 파일 공유 섹션을 참조하세요.

해당 UI: 출력 탭/아티팩트

Name

(action-name/Outputs/Artifacts/Name)

(Artifacts - output 포함 시 필수)

예시를 포함해 아티팩트에 대한 자세한 내용은 작업 간 아티팩트 및 파일 공유 섹션을 참조하세요.

해당 UI: 출력 탭/아티팩트/아티팩트 추가/빌드 아티팩트 이름

Files

(action-name/Outputs/Artifacts/Files)

(Artifacts - output 포함 시 필수)

CodeCatalyst가 작업으로 출력되는 아티팩트에 포함하는 파일을 지정합니다. 이러한 파일은 실행 시 워크플로 작업에 의해 생성되며 소스 리포지토리에서도 사용할 수 있습니다. 파일 경로는 소스 리포지토리 또는 이전 작업의 아티팩트에 상주할 수 있으며 소스 리포지토리 또는 아티팩트 루트와 관련이 있습니다. glob 패턴을 사용하여 경로를 지정할 수 있습니다. 예시:

빌드 위치 또는 소스 리포지토리 위치의 루트에 있는 단일 파일을 지정하려면 my-file.jar를 사용합니다..
하위 디렉터리에 단일 파일을 지정하려면 directory/my-file.jar 또는 directory/subdirectory/my-file.jar를 사용합니다.
모든 파일을 지정하려면 "**/*"를 사용합니다. ** glob 패턴은 임의의 수의 하위 디렉터리와 일치함을 나타냅니다.
directory라는 디렉터리에 있는 모든 파일 및 디렉터리를 지정하려면 "directory/**/*"를 사용합니다. ** glob 패턴은 임의의 수의 하위 디렉터리와 일치함을 나타냅니다.
directory라는 디렉터리의 모든 파일을 지정하되 해당 하위 디렉터리는 지정하지 않으려면 "directory/*"를 사용합니다.

참고

파일 경로에 별표(*) 또는 기타 특수 문자가 하나 이상 포함된 경우 경로를 큰따옴표("")로 묶습니다. 특수 문자에 대한 자세한 내용은 구문 지침 및 규칙 섹션을 참조하세요.

예시를 포함해 아티팩트에 대한 자세한 내용은 작업 간 아티팩트 및 파일 공유 섹션을 참조하세요.

참고

파일 경로에 접두사를 추가하여 찾을 아티팩트 또는 소스를 나타내야 할 수 있습니다. 자세한 내용은 소스 리포지토리 파일 참조 및 아티팩트의 파일 참조 섹션을 참조하세요.

해당 UI: 출력 탭/아티팩트/아티팩트 추가/빌드에서 생성된 파일

Variables - output

(action-name/Outputs/Variables)

(선택 사항)

후속 작업에서 사용할 수 있도록 작업을 내보낼 변수를 지정합니다.

예시를 비롯한 변수에 대한 자세한 내용은 워크플로에서 변수 사용 섹션을 참조하세요.

해당 UI: 출력 탭/변수/변수 추가

variable-name-1

(action-name/Outputs/Variablesvariable-name-1)

(선택 사항)

작업을 내보낼 변수의 이름을 지정합니다. 이 변수는 동일한 작업의 Inputs 또는 Steps 섹션에 이미 정의되어 있어야 합니다.

예시를 비롯한 변수에 대한 자세한 내용은 워크플로에서 변수 사용 섹션을 참조하세요.

해당 UI: 출력 탭/변수/변수 추가/이름

AutoDiscoverReports

(action-name/Outputs/AutoDiscoverReports)

(선택 사항)

자동 검색 기능의 구성을 정의합니다.

자동 검색을 활성화하면 CodeCatalyst는 작업에 전달된 모든 Inputs와 작업 자체에서 생성된 모든 파일을 검색하여 테스트, 코드 적용 범위 및 소프트웨어 구성 분석(SCA) 보고서를 찾습니다. 발견된 각 보고서에 대해 CodeCatalyst는 이를 CodeCatalyst 보고서로 변환합니다. CodeCatalyst 보고서는 CodeCatalyst 서비스에 완전히 통합되고 CodeCatalyst 콘솔을 통해 보고 조작할 수 있는 보고서입니다.

참고

기본적으로 자동 검색 기능은 모든 파일을 검사합니다. IncludePaths 또는 ExcludePaths 속성을 사용하여 검사할 파일을 제한할 수 있습니다.

해당 UI: 없음

Enabled

(action-name/Outputs/AutoDiscoverReports/Enabled)

(선택 사항)

자동 검색 기능을 활성화하거나 비활성화합니다.

유효한 값은 true 또는 false입니다.

Enabled 생략 시 기본값은 true입니다.

해당 UI: 출력 탭/보고서/자동 검색 보고서

ReportNamePrefix

(action-name/Outputs/AutoDiscoverReports/ReportNamePrefix)

(AutoDiscoverReports 포함 및 활성화 시 필수)

연결된 CodeCatalyst 보고서의 이름을 지정하기 위해 CodeCatalyst가 찾는 모든 보고서에 우선하는 접두사를 지정합니다. 예를 들어 접두사를 AutoDiscovered로 지정하고 CodeCatalyst가 두 개의 테스트 보고서, TestSuiteOne.xml 및 TestSuiteTwo.xml를 자동으로 검색하면 연결된 CodeCatalyst 보고서의 이름이 AutoDiscoveredTestSuiteOne 및 AutoDiscoveredTestSuiteTwo로 지정됩니다.

해당 UI: 출력 탭/보고서/보고서 자동 검색/보고서 접두사

IncludePaths

(action-name/Outputs/AutoDiscoverReports/IncludePaths)

(action-name/Outputs/Reports/report-name-1/IncludePaths)

(AutoDiscoverReports 포함 및 활성화 시 또는 Reports 포함 시 필수)

원시 보고서를 검색할 때 CodeCatalyst에 포함되는 파일 및 파일 경로를 지정합니다. 예를 들어 "/test/report/*" 지정 시 CodeCatalyst는 작업에서 /test/report/* 디렉터리를 찾는 데 사용되는 전체 빌드 이미지를 검색합니다. 해당 디렉터리를 찾으면 CodeCatalyst는 해당 디렉터리에서 보고서를 찾습니다.

참고

이 속성이 생략되면 기본값은 "**/*"입니다. 즉, 검색에 모든 경로의 모든 파일이 포함됩니다.

참고

수동으로 구성된 보고서의 경우 IncludePaths는 단일 파일과 일치하는 글로브 패턴이어야 합니다.

해당 UI:

출력 탭/보고서/보고서 자동 검색/'경로 포함/제외'/경로 포함
출력 탭/보고서/보고서 수동 구성/report-name-1/'경로 포함/제외'/경로 포함

ExcludePaths

(action-name/Outputs/AutoDiscoverReports/ExcludePaths)

(action-name/Outputs/Reports/ report-name-1/ExcludePaths)

(선택 사항)

원시 보고서를 검색할 때 CodeCatalyst에서 제외하는 파일 및 파일 경로를 지정합니다. 예를 들어 "/test/my-reports/**/*" 지정 시 CodeCatalyst는 /test/my-reports/ 디렉터리의 파일을 검색하지 않습니다. 디렉터리의 모든 파일을 무시하려면 **/* glob 패턴을 사용합니다.

참고

해당 UI:

출력 탭/보고서/보고서 자동 검색/'경로 포함/제외'/경로 제외
출력 탭/보고서/보고서 수동 구성/report-name-1/'경로 포함/제외'/경로 제외

SuccessCriteria

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria)

(action-name/Outputs/Reports/ report-name-1/SuccessCriteria)

(선택 사항)

테스트, 코드 적용 범위, 소프트웨어 구성 분석(SCA) 및 정적 분석(SA) 보고서의 성공 기준을 지정합니다.

자세한 내용은 보고서의 성공 기준 구성 섹션을 참조하세요.

해당 UI:

출력 탭/보고서/보고서 자동 검색/성공 기준
출력 탭/보고서/보고서 수동 구성/report-name-1/성공 기준

PassRate

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/PassRate)

(action-name/Outputs/Reports/report-name-1/SuccessCriteria/PassRate)

(선택 사항)

관련 CodeCatalyst 보고서를 통과로 표시하기 위해 통과해야 하는 테스트 보고서의 테스트 비율을 지정합니다. 유효한 값에는 십진수가 포함됩니다. 예시: 50, 60.5. 통과율 기준은 테스트 보고서에만 적용됩니다. 테스트 보고서에 대한 자세한 내용은 테스트 보고서의 내용을 참조하세요.

해당 UI:

출력 탭/보고서/보고서 자동 검색/성공 기준/통과율
출력 탭/보고서/보고서 수동 구성/report-name-1/성공 기준/통과율

LineCoverage

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/LineCoverage)

(action-name/Outputs/Reports/report-name-1/SuccessCriteria/LineCoverage)

(선택 사항)

연결된 CodeCatalyst 보고서를 통과로 표시하기 위해 다루어야 하는 코드 적용 범위 보고서의 줄 비율을 지정합니다. 유효한 값에는 십진수가 포함됩니다. 예시: 50, 60.5. 라인 적용 범위 기준은 코드 적용 범위 보고서에만 적용됩니다. 코드 적용 범위 보고서에 대한 자세한 내용은 코드 적용 범위 보고서 섹션을 참조하세요.

해당 UI:

출력 탭/보고서/보고서 자동 검색/성공 기준/라인 적용 범위
출력 탭/보고서/보고서 수동 구성/report-name-1/성공 기준/라인 적용 범위

BranchCoverage

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/BranchCoverage)

(action-name/Outputs/Reports/report-name-1/SuccessCriteria/BranchCoverage)

(선택 사항)

연결된 CodeCatalyst 보고서를 통과로 표시하기 위해 다루어야 하는 코드 적용 범위 보고서의 브랜치 비율을 지정합니다. 유효한 값에는 십진수가 포함됩니다. 예시: 50, 60.5. 브랜치 적용 범위 기준은 코드 적용 범위 보고서에만 적용됩니다. 코드 적용 범위 보고서에 대한 자세한 내용은 코드 적용 범위 보고서 섹션을 참조하세요.

해당 UI:

출력 탭/보고서/보고서 자동 검색/성공 기준/브랜치 적용 범위
출력 탭/보고서/보고서 수동 구성/report-name-1/성공 기준/브랜치 적용 범위

Vulnerabilities

(action-name/Outputs/AutoDiscoverReports/SuccessCriteria/Vulnerabilities)

(action-name/Outputs/Reports/report-name-1/SuccessCriteria/Vulnerabilities)

(선택 사항)

SCA 보고서에서 허용되는 취약성의 최대 수와 심각도를 지정하여 관련 CodeCatalyst 보고서를 통과로 표시합니다. 취약성을 지정하려면 다음을 지정해야 합니다.

개수에 포함하려는 취약성의 최소 심각도입니다. 최대부터 최소 심각도까지 유효한 값은 CRITICAL, HIGH, MEDIUM, LOW 및 INFORMATIONAL입니다.

예를 들어 HIGH 선택 시 HIGH 및 CRITICAL 취약성이 집계됩니다.
허용하려는 지정된 심각도의 최대 취약성 수입니다. 이 수를 초과하면 CodeCatalyst 보고서가 실패로 표시됩니다. 유효한 값은 정수입니다.

취약성 기준은 SCA 보고서에만 적용됩니다. SCA 보고서에 대한 자세한 내용은 소프트웨어 구성 분석 보고서의 내용을 참조하세요.

최소 심각도를 지정하려면 Severity 속성을 사용합니다. 최대 취약성 수를 지정하려면 Number 속성을 사용합니다.

SCA 보고서에 대한 자세한 내용은 품질 보고서 유형의 내용을 참조하세요.

해당 UI:

출력 탭/보고서/보고서 자동 검색/성공 기준/취약성
출력 탭/보고서/보고서 수동 구성/report-name-1/성공 기준/취약성

Reports

(action-name/Outputs/Reports )

(선택 사항)

테스트 보고서의 구성을 지정하는 섹션입니다.

해당 UI: 출력 탭/보고서

report-name-1

(action-name/Outputs/Reports/report-name-1 )

(Reports 포함 시 필수)

원시 보고서에서 생성될 CodeCatalyst 보고서에 부여할 이름입니다.

해당 UI: 출력 탭/보고서 수동 구성/보고서 이름

Format

(action-name/Outputs/Reports/report-name-1/Format)

(Reports 포함 시 필수)

보고서에 사용할 파일 형식을 지정합니다. 가능한 값은 다음과 같습니다.

테스트 보고서의 경우:
- Cucumber JSON에서 Cucumber(시각 편집기) 또는 CUCUMBERJSON(YAML 편집기)를 지정합니다.
- JUnit XML에 JUnit(시각 편집기) 또는 JUNITXML(YAML 편집기)를 지정합니다.
- NUnit XML에 NUnit(시각 편집기) 또는 NUNITXML(YAML 편집기)를 지정합니다.
- NUnit 3 XML에서 NUnit3(시각 편집기) 또는 NUNIT3XML(YAML 편집기)를 지정합니다.
- Visual Studio TRX에서 Visual Studio TRX(시각 편집기) 또는 VISUALSTUDIOTRX(YAML 편집기)를 지정합니다.
- TestNG XML에서 TestNG(시각 편집기) 또는 TESTNGXML(YAML 편집기)를 지정합니다.
코드 적용 범위 보고서의 경우:
- Clover XML에서 Clover(시각 편집기) 또는 CLOVERXML(YAML 편집기)를 지정합니다.
- Cobertura XML에서 Cobertura(시각 편집기) 또는 COBERTURAXML(YAML 편집기)를 지정합니다.
- JaCoCo XML의 경우 JaCoCo(시각 편집기) 또는 JACOCOXML(YAML 편집기)를 지정합니다.
- Simplecov-json이 아닌 simplecov에서 생성한 SimpleCov JSON의 경우 Simplecov(시각 편집기) 또는 SIMPLECOV(YAML 편집기)를 지정합니다.
소프트웨어 구성 분석(SCA) 보고서의 경우:
- SARIF에서 SARIF(시각 편집기) 또는 SARIFSCA(YAML 편집기)를 지정합니다.

해당 UI: 출력 탭/보고서/보고서 수동 구성/보고서 추가/report–name-1/보고서 유형 및 보고서 형식

Configuration

(action-name/Configuration)

(필수) 작업의 구성 속성을 정의할 수 있는 섹션입니다.

해당 UI: 구성 탭

Steps

(action-name/Configuration/Steps)

(필수)

GitHub Marketplace의 작업 세부 정보 페이지에 표시되는 대로 GitHub 작업 코드를 지정합니다. 다음 지침에 따라 코드를 추가합니다.

GitHub 작업 steps: 섹션의 코드를 CodeCatalyst 워크플로의 Steps: 섹션에 붙여 넣습니다. 코드는 대시(-)로 시작하며 다음과 비슷합니다.

붙여넣을 GitHub 코드:


- name: Lint Code Base
  uses: github/super-linter@v4
  env:
    VALIDATE_ALL_CODEBASE: false
    DEFAULT_BRANCH: master
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

방금 붙여넣은 코드를 검토하고 CodeCatalyst 표준을 준수하도록 필요에 따라 수정합니다. 예를 들어 앞의 코드 블록을 사용하면 빨간색 기울임꼴로 된 코드를 제거하고 굵은 글씨체로 된 코드를 추가할 수 있습니다.

CodeCatalyst 워크플로 yaml:
```
Steps:      
   - name: Lint Code Base
     uses: github/super-linter@v4
     env:
       VALIDATE_ALL_CODEBASE: false
       DEFAULT_BRANCH: mastermain
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
GitHub 작업에 포함되지만 steps: 섹션 내에 존재하지 않는 추가 코드는 CodeCatalyst에서 해당하는 코드를 사용하여 CodeCatalyst 워크플로에 추가합니다. 워크플로 YAML 정의를 검토하여 GitHub 코드를 CodeCatalyst에 이식하는 방법에 대한 인사이트를 얻을 수 있습니다. 자세한 마이그레이션 단계는 이 가이드의 범위를 벗어납니다.

다음은 GitHub Actions 작업에서 파일 경로를 지정하는 방법의 예입니다.


Steps:
  - name: Lint Code Base
    uses: github/super-linter@v4
    ...
  - run: cd /sources/WorkflowSource/MyFolder/  && cat file.txt
  - run: cd /artifacts/MyGitHubAction/MyArtifact/MyFolder/  && cat file2.txt

파일 경로 지정에 대한 자세한 내용은 소스 리포지토리 파일 참조 및 아티팩트의 파일 참조를 참조하세요.

해당 UI: 구성 탭/GitHub Actions YAML

javascript가 브라우저에서 비활성화되거나 사용이 불가합니다.

AWS 설명서를 사용하려면 Javascript가 활성화되어야 합니다. 지침을 보려면 브라우저의 도움말 페이지를 참조하십시오.

문서 규칙

GitHub 출력 파라미터 참조

컴퓨팅 및 런타임 이미지 구성

이 페이지에서

쿠키 기본 설정 선택

'GitHub Actions' 작업 YAML

참고

action-name

Identifier

DependsOn

Compute

Fleet

Timeout

Environment

참고

Name

Connections

Name

Role

참고

주의

Inputs

참고

Sources

Artifacts - input

참고

Variables - input

Outputs

Artifacts - output

Name

Files

참고

참고

Variables - output

variable-name-1

AutoDiscoverReports

참고

Enabled

ReportNamePrefix

IncludePaths

참고

참고

ExcludePaths

참고

SuccessCriteria

PassRate

LineCoverage

BranchCoverage

Vulnerabilities

Reports

report-name-1

Format

Configuration

Steps

이 페이지에서

페이지 내용이 도움이 되었습니까?

다음 주제:

이전 주제:

도움이 필요하십니까?