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

action-name

(必須)

アクションの名前を指定します。すべてのアクション名は、ワークフロー内で一意である必要があります。アクション名は、英数字 (a～z、A～Z、0～9)、ハイフン (-)、アンダースコア (_) に制限されています。スペースは使用できません。引用符を使用してアクション名で特殊文字やスペースを有効にすることはできません。

対応する UI: 設定タブ/action-name

Identifier

(action-name/Identifier)

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

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

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

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ロールを使用してに接続し AWS アカウント、Amazon VPC接続で指定されたIAMロールを使用して Amazon に接続しますVPC。

注記

デフォルトの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?/3 つのドットメニュー/スイッチロール

Name

(action-name/Environment/Connections/Name)

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

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

対応する UI: 設定タブ/環境/ の内容 my-environment?/3 つのドットメニュー/スイッチロール

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?/3 つのドットメニュー/スイッチロール

Inputs

(action-name/Inputs)

(オプション)

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

注記

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

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

対応する UI: Inputs タブ

Sources

(action-name/Inputs/Sources)

(オプション)

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

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

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

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

Artifacts - input

(action-name/Inputs/Artifacts)

(オプション)

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

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

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

注記

アーティファクト - オプションのドロップダウンリストが使用できない場合 (ビジュアルエディタ）、または 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が含まれている場合は必須）

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

対応する 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: 出力タブ/変数/変数の追加

変数名 1

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

(オプション)

アクションでエクスポートする変数の名前を指定します。この変数は、同じアクションの Inputsまたは Stepsセクションで既に定義されている必要があります。

例を含む変数の詳細については、「」を参照してくださいワークフローでの変数の使用。

対応する UI: Outputs tab/Variables/Add variable/Name

AutoDiscoverReports

(action-name/Outputs/AutoDiscoverReports)

(オプション)

自動検出機能の設定を定義します。

自動検出を有効にすると、は、アクションに渡Inputsされたすべてのファイルと、アクション自体によって生成されたすべてのファイル CodeCatalyst を検索し、テスト、コードカバレッジ、ソフトウェアコンポジション分析 (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、2 つのテストレポート TestSuiteOne.xmlとを自動検出するとTestSuiteTwo.xml、関連する CodeCatalyst レポートの名前は AutoDiscoveredTestSuiteOneとになりますAutoDiscoveredTestSuiteTwo。

対応する UI: 出力タブ/レポート/レポートの自動検出/レポートプレフィックス

IncludePaths

(action-name/Outputs/AutoDiscoverReports/IncludePaths)

または

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

( AutoDiscoverReportsが含まれ、有効になっている場合、または Reports が含まれている場合は必須）

raw レポートを検索するときに CodeCatalyst に含まれるファイルとファイルパスを指定します。例えば、を指定した場合"/test/report/*"、は /test/report/* ディレクトリを検索するアクションで使用されるビルドイメージ全体 CodeCatalyst を検索します。そのディレクトリが見つか CodeCatalyst ると、はそのディレクトリ内のレポートを検索します。

注記

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

注記

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

対応する UI:

出力タブ/レポート/レポートを自動的に検出/'Include/exclude paths'/Include paths
出力タブ/レポート/レポートを手動で設定/report-name-1/'Include/exclude パス'/Include パス

ExcludePaths

(action-name/Outputs/AutoDiscoverReports/ExcludePaths)

または

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

(オプション)

raw レポートを検索するときにが CodeCatalyst 除外するファイルとファイルパスを指定します。例えば、を指定した場合"/test/my-reports/**/*"、 CodeCatalyst は /test/my-reports/ ディレクトリ内のファイルを検索しません。ディレクトリ内のすべてのファイルを無視するには、glob **/* パターンを使用します。

注記

対応する UI:

出力タブ/レポート/レポートの自動検出/'Include/exclude paths'/Exclude paths
出力タブ/レポート/レポートを手動で設定/report-name-1/'Include/exclude paths'/Exclude paths

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レポートが合格としてマークされるようにするために合格する必要があるテストレポート内のテストの割合を指定します。有効な値には 10 進数が含まれます。例: 50、60.5。合格率基準はテストレポートにのみ適用されます。テストレポートの詳細については、「」を参照してくださいテストレポート。

対応する UI:

出力タブ/レポート/レポートの自動検出/成功基準/合格率
出力タブ/レポート/レポートを手動で設定/report-name-1/成功基準/合格率

LineCoverage

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

または

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

または

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

または

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

(オプション)

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

カウントに含める脆弱性の最小重要度。最も重要度の高い値から低い値までの有効な値は、CRITICAL、HIGH、、MEDIUMLOW、です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が含まれている場合は必須）

raw 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 エディタ) を指定します。
- 3 NUnitの場合はXML、 NUnit3 (ビジュアルエディタ) または NUNIT3XML (YAML エディタ) を指定します。
- Visual Studio ではTRX、Visual Studio TRX (ビジュアルエディタ) または VISUALSTUDIOTRX (YAMLエディタ) を指定します。
- TestNG にはXML、TestNG (ビジュアルエディタ) または TESTNGXML (YAMLエディタ) を指定します。
コードカバレッジレポートの場合：
- クローバーにはXML、クローバー (ビジュアルエディタ) または CLOVERXML (YAML エディタ) を指定します。
- コベルチュラにはXML、コベルチュラ (ビジュアルエディタ) または COBERTURAXML (YAML エディタ) を指定します。
- には JaCoCo XML、 JaCoCo (ビジュアルエディタ) または JACOCOXML (YAML エディタ) を指定します。
- simplecov- SimpleCov JSONjson ではなく simplecov によって生成されたには、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するように必要に応じて変更します。例えば、前述のコードブロックでは、でコードを削除できます。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 }}
```
GitHub アクションに含まれているが、 steps:セクション内に存在しない追加のコードについては、 CodeCatalystと同等のコードを使用して CodeCatalyst ワークフローに追加します。を確認してワークフローYAML定義、 GitHub コードをに移植する方法に関するインサイトを得ることができます CodeCatalyst。詳細な移行手順は、このガイドの対象外です。

GitHub アクションアクションでファイルパスを指定する方法の例を次に示します。


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

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

GitHub 出力パラメータの参照

コンピューティングイメージとランタイムイメージの設定