'GitHub 액션' 액션 YAML - Amazon CodeCatalyst
액션 이름IdentifierDependsOnComputeFleetTimeoutEnvironmentNameConnectionsNameRoleInputsSourcesArtifacts - inputVariables - inputOutputsArtifacts - outputNameFilesVariables - output변수 이름-1AutoDiscoverReportsEnabledReportNamePrefixIncludePathsExcludePathsSuccessCriteriaPassRateLineCoverageBranchCoverageVulnerabilitiesReports보고서 이름-1FormatConfigurationSteps

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

'GitHub 액션' 액션 YAML

GitHub액션 액션의 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

액션 이름

(필수)

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

해당 UI: 구성 탭/action-name

Identifier

(action-name/Identifier)

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

aws/github-actions-runner@v1GitHub액션에 사용 작업.

해당 UI: 워크플로 다이어그램/action-name/AWS/ @v1 라벨 github-actions-runner

DependsOn

(action-name/DependsOn)

(선택 사항)

이 액션을 실행하기 위해 성공적으로 실행되어야 하는 액션, 액션 그룹 또는 게이트를 지정하십시오.

'종속 조건' 기능에 대한 자세한 내용은 을 참조하십시오. 시퀀스 작업

해당 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 환경을 지정합니다. 작업은 선택한 환경에 VPC 지정된 AWS 계정 및 선택적 Amazon에 연결됩니다. 작업은 환경에 지정된 기본 IAM 역할을 사용하여 Amazon에 연결하고 Amazon VPC 연결에 지정된 IAM 역할을 사용하여 Amazon에 연결합니다VPC. AWS 계정

참고

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

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

해당 UI: 구성 탭/ 환경

Name

(action-name/Environment/Name)

(포함된 Environment 경우 필수)

작업에 연결할 기존 환경의 이름을 지정합니다.

해당 UI: 구성 탭/ 환경

Connections

(action-name/Environment/Connections)

(선택 사항)

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

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

  • 작업은 CodeCatalyst 콘솔 환경에 지정된 AWS 계정 연결 및 기본 IAM 역할을 사용합니다. 환경에 계정 연결 및 기본 IAM 역할을 추가하는 방법에 대한 자세한 내용은 을 참조하십시오환경 생성.

  • 기본 IAM 역할에는 작업에 필요한 정책 및 권한이 포함되어야 합니다. 이러한 정책 및 권한이 무엇인지 확인하려면 작업 YAML 정의 설명서에서 역할 속성에 대한 설명을 참조하십시오.

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

해당 UI: 구성 탭/환경/내용 my-environment? /쓰리 닷 메뉴/ 역할 전환

Name

(action-name/Environment/Connections/Name)

(포함된 경우 Connections 필수)

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

해당 UI: 구성 탭/환경/내용 my-environment? /쓰리 닷 메뉴/ 역할 전환

Role

(action-name/Environment/Connections/Role)

(포함된 경우 Connections 필수)

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

IAM역할을 지정하지 않으면 CodeCatalyst 콘솔 환경에 나열된 기본 IAM 역할이 작업에 사용됩니다. 환경에서 기본 역할을 사용하는 경우 해당 역할에 다음 정책이 적용되는지 확인하십시오.

참고

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

주의

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

해당 UI: 구성 탭/환경/내용 my-environment? /쓰리 닷 메뉴/ 역할 전환

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 경우 필수)

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

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

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

Files

(action-name/Outputs/Artifacts/Files)

Artifacts - output(포함된 경우 필수)

액션에 의해 출력되는 아티팩트에 CodeCatalyst 포함할 파일을 지정합니다. 이러한 파일은 워크플로 작업이 실행될 때 생성되며 소스 저장소에서도 사용할 수 있습니다. 파일 경로는 소스 리포지토리 또는 이전 작업의 아티팩트에 있을 수 있으며 소스 리포지토리 또는 아티팩트 루트를 기준으로 합니다. 글로브 패턴을 사용하여 경로를 지정할 수 있습니다. 예시:

  • 빌드 위치 또는 소스 리포지토리 위치의 루트에 있는 단일 파일을 지정하려면 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: 출력 탭/변수/ 변수 추가

변수 이름-1

(action-name/Outputs/Variables변수 이름-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 예를 들어 접두사를 지정하고 두 개의 테스트 보고서를 CodeCatalyst 자동으로 검색하는 경우 관련 CodeCatalyst 보고서의 이름은 TestSuiteOne.xml 및 TestSuiteTwo.xml 로 지정됩니다. AutoDiscovered AutoDiscoveredTestSuiteOne AutoDiscoveredTestSuiteTwo

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

IncludePaths

(action-name/Outputs/AutoDiscoverReports/IncludePaths)

Or

(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)

Or

(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)

Or

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

(선택 사항)

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

자세한 내용은 보고서의 성공 기준 구성 단원을 참조하십시오.

해당 UI:

  • 출력 탭/보고서/보고서 자동 검색/성공 기준

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

PassRate

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

Or

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

(선택 사항)

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

해당 UI:

  • 출력 탭/보고서/보고서 자동 검색/성공 기준/합격률

  • 출력 탭/보고서/보고서 수동 구성/report-name-1/성공 기준/ 합격률

LineCoverage

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

Or

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

(선택 사항)

관련 보고서가 통과로 표시되기 위해 포함되어야 하는 코드 커버리지 CodeCatalyst 보고서의 줄 비율을 지정합니다. 유효한 값에는 10진수가 포함됩니다. 예: 50, 60.5. 라인 커버리지 기준은 코드 커버리지 보고서에만 적용됩니다. 코드 커버리지 보고서에 대한 자세한 내용은 을 참조하십시오코드 범위 보고서.

해당 UI:

  • 출력 탭/보고서/보고서 자동 검색/성공 기준/회선 커버리지

  • 출력 탭/보고서/보고서 수동 구성/report-name-1/성공 기준/ 회선 커버리지

BranchCoverage

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

Or

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

(선택 사항)

코드 커버리지 보고서에서 관련 CodeCatalyst 보고서를 통과로 표시하기 위해 반드시 포함해야 하는 브랜치의 비율을 지정하십시오. 유효한 값에는 10진수가 포함됩니다. 예: 50, 60.5. 브랜치 커버리지 기준은 코드 커버리지 보고서에만 적용됩니다. 코드 커버리지 보고서에 대한 자세한 내용은 을 참조하십시오코드 범위 보고서.

해당 UI:

  • 출력 탭/보고서/보고서 자동 검색/성공 기준/지사 커버리지

  • 출력 탭/보고서/보고서 수동 구성/report-name-1/성공 기준/ 지사 커버리지

Vulnerabilities

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

Or

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

(선택 사항)

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

  • 집계에 포함하려는 취약성의 최소 심각도. 가장 심각한 값부터 가장 심각하지 않은 값까지 유효한 값은,CRITICAL,, HIGH MEDIUMLOW, INFORMATIONAL 입니다.

    예를 들어HIGH, 선택하면 HIGH CRITICAL 취약성이 집계됩니다.

  • 허용하려는 지정된 심각도 내에서 허용되는 최대 취약성 수입니다. 이 수를 초과하면 CodeCatalyst 보고서가 실패로 표시됩니다. 유효한 값은 정수입니다.

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

최소 심각도를 지정하려면 Severity 속성을 사용하십시오. 최대 취약성 수를 지정하려면 Number 속성을 사용하십시오.

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

해당 UI:

  • 출력 탭/보고서/보고서 자동 검색/성공 기준/취약성

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

Reports

(action-name/Outputs/Reports )

(선택 사항)

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

해당 UI: 출력 탭/ 보고서

보고서 이름-1

(action-name/Outputs/Reports/보고서 이름-1)

(포함된 경우 필수) Reports

원시 보고서에서 생성될 CodeCatalyst 보고서에 부여하려는 이름.

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

Format

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

Reports(포함된 경우 필수)

보고서에 사용하는 파일 형식을 지정하십시오. 가능한 값은 다음과 같습니다.

  • 테스트 보고서의 경우:

    • 오이의 경우 JSON Cucumber (비주얼 에디터) 또는 CUCUMBERJSON (YAML에디터) 를 지정하십시오.

    • 의 JUnit XML 경우 JUnit(비주얼 편집기) 또는 JUNITXML (YAML편집기) 를 지정합니다.

    • NUnitXML경우 NUnit(비주얼 편집기) 또는 NUNITXML (YAML편집기) 를 지정하십시오.

    • NUnit3의 XML 경우 NUnit3(비주얼 편집기) 또는 NUNIT3XML (YAML편집기) 를 지정합니다.

    • 비주얼 TRX 스튜디오의 경우 Visual Studio TRX (비주얼 편집기) 또는 VISUALSTUDIOTRX (YAML편집기) 를 지정합니다.

    • TestNG의 경우 XML TestNG (비주얼 편집기) 또는 TESTNGXML (편집기) 를 지정하십시오. YAML

  • 코드 커버리지 보고서의 경우:

    • Clover의 경우 Clover XML (비주얼 에디터) 또는 CLOVERXML (YAML에디터) 를 지정하십시오.

    • Cobertura의 경우 Cobertura XML (비주얼 편집기) 또는 (편집기) 를 지정합니다. 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 액션 세부정보 페이지에 표시되는 대로 액션 코드를 지정하십시오. 다음 가이드라인에 따라 코드를 추가하세요.

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

    GitHub 붙여넣을 코드:

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

  2. 방금 붙여넣은 코드를 검토하고 표준에 맞도록 필요에 따라 수정하십시오. CodeCatalyst 예를 들어, 위의 코드 블록을 사용하여 에서 코드를 제거할 수 있습니다.red italics그리고 굵은 글씨로 코드를 추가합니다.

    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 }}

  3. GitHub Action에 포함되어 있지만 steps: 섹션 내에는 없는 추가 코드가 필요하면 CodeCatalyst -equirent 코드를 사용하여 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 YAML