GitHub Actions アクション YAML - Amazon CodeCatalyst
action-nameIdentifierDependsOnComputeFleetTimeoutEnvironmentNameConnectionsNameRoleInputsSourcesArtifacts - inputVariables - inputOutputsArtifacts - outputNameFilesVariables - outputvariable-name-1AutoDiscoverReportsEnabledReportNamePrefixIncludePathsExcludePathsSuccessCriteriaPassRateLineCoverageBranchCoverageVulnerabilitiesReportsreport-name-1FormatConfigurationSteps

Amazon CodeCatalyst は、2025 年 11 月 7 日以降、新規のお客様に公開されなくなります。サービスを使用する場合は、2025 年 11 月 7 日までにサインアップしてください。詳細については、「CodeCatalyst から移行する方法」を参照してください。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

GitHub Actions アクション YAML

以下は、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)

アクションを識別します。バージョンを変更したい場合でない限り、このプロパティを変更しないでください。詳細については、「使用するアクションバージョンの指定」を参照してください。

GitHub Actions アクションには aws/github-actions-runner@v1 を使用します。

対応する UI: ワークフロー図/action-name/aws/github-actions-runner@v1 ラベル

DependsOn

(action-name/DependsOn)

(オプション)

このアクションを実行するために正常に実行する必要があるアクション、アクショングループ、またはゲートを指定します。

「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 環境を指定します。アクションは、選択した環境で指定された AWS アカウント およびオプションの Amazon VPC に接続します。アクションは、 環境内で指定されたデフォルトの IAM ロールを使用して に接続し AWS アカウント、Amazon VPC 接続で指定された IAM ロールを使用して 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: [設定] タブ/[環境]/[my-environment の内容]/3 つのドットメニュー/[ロールを切り替える]

Name

(action-name/Environment/Connections/Name)

(Connections が含まれている場合は必須)

アカウント接続の名前を指定します。

対応する UI: [設定] タブ/[環境]/[my-environment の内容]/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 Action アクションに必要なアクセス許可に制限します。範囲の広いアクセス許可を持つロールを使用すると、セキュリティリスクが発生する可能性があります。

対応する UI: [設定] タブ/[環境]/[my-environment の内容]/3 つのドットメニュー/[ロールを切り替える]

Inputs

(action-name/Inputs)

(オプション)

Inputs セクションは、ワークフローの実行中にアクションに必要なデータを定義します。

注記

GitHub Actions アクションごとに最大 4 つの入力 (1 つのソースと 3 つのアーティファクト) が許可されます。変数はこの合計にはカウントされません。

異なる入力 (ソースとアーティファクトなど) にあるファイルを参照する必要がある場合、ソース入力はプライマリ入力で、アーティファクトはセカンダリ入力になります。セカンダリ入力内のファイルへの参照には、プライマリからファイルを区別するための特別なプレフィックスが付きます。詳細については、「例: 複数のアーティファクトでのファイルの参照」を参照してください。

対応する UI: [入力] タブ

Sources

(action-name/Inputs/Sources)

(オプション)

アクションに必要なソースリポジトリを表すラベルを指定します。現在、サポートされているラベルは WorkflowSource のみです。これは、ワークフロー定義ファイルが保存されているソースリポジトリを表します。

ソースを省略する場合は、action-name/Inputs/Artifacts で少なくとも 1 つの入力アーティファクトを指定する必要があります。

sources の詳細については、「ワークフローへのソースリポジトリの接続」を参照してください。

対応する UI: [入力] タブ/[ソース - オプション]

Artifacts - input

(action-name/Inputs/Artifacts)

(オプション)

このアクションへの入力として提供する以前のアクションのアーティファクトを指定します。これらのアーティファクトは、前のアクションで出力アーティファクトとして既に定義されている必要があります。

入力アーティファクトを指定しない場合は、action-name/Inputs/Sources で少なくとも 1 つのソースリポジトリを指定する必要があります。

アーティファクトの詳細 (例を含む) については、「アクション間でのアーティファクトとファイルの共有」を参照してください。

注記

[アーティファクト - オプション] のドロップダウンリストが使用できない場合 (ビジュアルエディタ)、または YAML の検証時にエラーが発生する場合 (YAML エディタ)、アクションが 1 つの入力のみをサポートしていることが原因である可能性があります。この場合はソース入力を削除してみてください。

対応する 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 がアクションによって出力されるアーティファクトに含めるファイルを指定します。これらのファイルは、実行時にワークフローアクションによって生成され、ソースリポジトリでも使用できます。ファイルパスは、ソースリポジトリまたは前のアクションからのアーティファクトに設定でき、ソースリポジトリまたはアーティファクトルートを基準とすることができます。glob パターンを使用してパスを指定できます。例:

  • ビルドまたはソースリポジトリの場所のルートにある 1 つのファイルを指定するには、my-file.jar を使用します。

  • サブディレクトリ内の 1 つのファイルを指定するには、directory/my-file.jar または directory/subdirectory/my-file.jar を使用します。

  • すべてのファイルを指定するには、"**/*" を使用します。glob パターン ** は、任意の数のサブディレクトリにマッチすることを示します。

  • directory という名前のディレクトリ内のすべてのファイルとディレクトリを指定するには、"directory/**/*" を使用します。glob パターン ** は、任意の数のサブディレクトリにマッチすることを示します。

  • directory という名前のディレクトリ内のすべてのファイルを指定するが、そのサブディレクトリを含めないようにするには、"directory/*" を使用します。

注記

ファイルパスに 1 つ以上のアスタリスク (*) またはその他の特殊文字が含まれている場合は、パスを二重引用符 ("") で囲みます。特殊文字の詳細については、「構文ガイドラインと規則」を参照してください。

アーティファクトの詳細 (例を含む) については、「アクション間でのアーティファクトとファイルの共有」を参照してください。

注記

場合によっては、ファイルパスにプレフィックスを追加して、どのアーティファクトまたはソースにあるのかを示す必要があります。詳細については、ソースリポジトリファイルの参照およびアーティファクト内のファイルの参照を参照してください。

対応する 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 コンソールを介して表示および操作できます。

注記

デフォルトでは、自動検出機能はすべてのファイルを検査します。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 が 2 つのテストレポート、TestSuiteOne.xml、TestSuiteTwo.xml を自動的に検出する場合、関連する CodeCatalyst レポートには 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 はそのディレクトリ内のレポートを検索します。

注記

ファイルパスに 1 つ以上のアスタリスク (*) またはその他の特殊文字が含まれている場合は、パスを二重引用符 ("") で囲みます。特殊文字の詳細については、「構文ガイドラインと規則」を参照してください。

このプロパティを省略した場合、デフォルトは "**/*" です。つまり、検索にはすべてのパスのすべてのファイルが含まれます。

注記

手動で設定するレポートの場合、IncludePaths は単一のファイルに一致する glob パターンである必要があります。

対応する 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 パターンを使用します。

注記

ファイルパスに 1 つ以上のアスタリスク (*) またはその他の特殊文字が含まれている場合は、パスを二重引用符 ("") で囲みます。特殊文字の詳細については、「構文ガイドラインと規則」を参照してください。

対応する 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)

(オプション)

関連する CodeCatalyst レポートが合格としてマークされるために、SCA レポートで許容される脆弱性の数と重要度の上限を指定します。脆弱性を指定するには、以下を指定する必要があります。

  • カウントに含める脆弱性の最小重要度。有効な値は、重要度が高い順に 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 Action コードを、GitHub Marketplace のアクションの詳細ページに表示されるとおりに指定します。次のガイドラインに従ってコードを追加します。

  1. GitHub Action の 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 }}

  2. 貼り付けたコードをレビューし、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 }}

  3. GitHub Action に含まれているが、steps: セクション内に存在しない追加のコードについては、CodeCatalyst の対応するコードを使用して CodeCatalyst ワークフローに追加します。GitHub コードを CodeCatalyst に移植する方法については、「ワークフロー YAML 定義」を参照してください。詳細な移行手順は、このガイドの範囲外です。

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]