キュレートされた GitHub Action を追加する - Amazon CodeCatalyst

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

キュレートされた GitHub Action を追加する

キュレートされた GitHub Action とは、CodeCatalyst コンソールで利用できる GitHub Action であり、CodeCatalyst ワークフロー内で GitHub Action を使用する方法の例として機能します。

キュレートされた GitHub Actions は、aws/github-actions-runner@v1 識別子で識別される、CodeCatalyst によって作成された GitHub Actions アクションでラップされます。例えば、キュレートされた GitHub Action である TruffleHog OSS は次のようになります。

Actions: TruffleHogOSS_e8: Identifier: aws/github-actions-runner@v1 Inputs: Sources: - WorkflowSource # This specifies that the action requires this Workflow as a source Configuration: Steps: - uses: trufflesecurity/trufflehog@v3.16.0 with: path: ' ' # Required; description: Repository path base: ' ' # Required; description: Start scanning from here (usually main branch). head: ' ' # Optional; description: Scan commits until here (usually dev branch). extra_args: ' ' # Optional; description: Extra args to be passed to the trufflehog cli.

前のコードでは、CodeCatalyst GitHub Actions アクション (aws/github-actions-runner@v1 で識別される) は TruffleHog OSS アクション (trufflesecurity/trufflehog@v3.16.0 で識別される) をラップし、CodeCatalyst ワークフローで機能するようにしています。

このアクションを設定するには、with: の下にある空の文字列を実際の値に置き換えます。例:

Actions: TruffleHogOSS_e8: Identifier: aws/github-actions-runner@v1 Inputs: Sources: - WorkflowSource # This specifies that the action requires this Workflow as a source Configuration: Steps: - uses: trufflesecurity/trufflehog@v3.16.0 with: path: ./ base: main # Required; description: Start scanning from here (usually main branch). head: HEAD # Optional; description: Scan commits until here (usually dev branch). extra_args: '‐‐debug ‐‐only-verified' # Optional; description: Extra args to be passed to the trufflehog cli.

キュレートされた GitHub Action をワークフローに追加する手順は次のとおりです。CodeCatalyst ワークフローでの GitHub Action の使用に関する一般的な情報については、「GitHub Actions との統合」を参照してください。

注記

キュレートされたアクションのリストに GitHub Action が表示されない場合は、GitHub Actions アクションを使用してワークフローに追加できます。詳細については、「GitHub Actions アクションを追加する」を参照してください。

Visual
ビジュアルエディタを使用してキュレートされた GitHub Action を追加するには
  1. https://codecatalyst.aws/ で CodeCatalyst コンソールを開きます。

  2. プロジェクトを選択します。

  3. ナビゲーションペインで [CI/CD][ワークフロー] の順に選択します。

  4. ワークフローの名前を選択します。ワークフローが定義されているソースリポジトリまたはブランチ名でフィルタリングすることも、ワークフローの名前またはステータスでフィルタリングすることもできます。

  5. [編集] を選択します。

  6. [ビジュアル] を選択します。

  7. 左上で [+ アクション] を選択してアクションカタログを開きます。

  8. ドロップダウンリストから [GitHub] を選択します。

  9. GitHub Action を参照または検索し、次のいずれかを実行します。

    • プラス記号 () を選択してワークフロー図にアクションを追加し、設定ペインを開きます。

      または

    • GitHub Action の名前を選択します。アクションの詳細ダイアログボックスが表示されます。このダイアログボックスで、次の操作を行います。

  10. [入力][設定][出力] タブで、必要に応じてフィールドに入力します。各フィールドの説明については、「GitHub Actions アクション YAML」を参照してください。このリファレンスでは、GitHub Actions アクションで利用可能な各フィールド (および対応する YAML プロパティ値) について、YAML エディタとビジュアルエディタの両方で表示される詳細情報を提供しています。

    キュレートされた GitHub Action で使用できる設定オプションについては、該当するドキュメントを参照してください。

  11. (オプション) [検証] を選択して、ワークフローの YAML コードをコミットする前に検証します。

  12. [コミット] を選択し、コミットメッセージを入力し、再度 [コミット] を選択します。

YAML
YAML エディタを使用してキュレートされた GitHub アクションを追加するには
  1. https://codecatalyst.aws/ で CodeCatalyst コンソールを開きます。

  2. プロジェクトを選択します。

  3. ナビゲーションペインで [CI/CD][ワークフロー] の順に選択します。

  4. ワークフローの名前を選択します。ワークフローが定義されているソースリポジトリまたはブランチ名でフィルタリングすることも、ワークフローの名前またはステータスでフィルタリングすることもできます。

  5. [編集] を選択します。

  6. [YAML] を選択します。

  7. 左上で [+ アクション] を選択してアクションカタログを開きます。

  8. ドロップダウンリストから [GitHub] を選択します。

  9. GitHub Action を参照または検索し、次のいずれかを実行します。

    • プラス記号 () を選択してワークフロー図にアクションを追加し、設定ペインを開きます。

      または

    • GitHub Action の名前を選択します。アクションの詳細ダイアログボックスが表示されます。このダイアログボックスで、次の操作を行います。

  10. 必要に応じて、YAML コードのプロパティを変更します。GitHub Actions アクションで使用可能な各プロパティの説明は、「GitHub Actions アクション YAML」に記載されています。

    キュレートされた GitHub Action で使用できる設定オプションについては、該当するドキュメントを参照してください。

  11. (オプション) [検証] を選択して、ワークフローの YAML コードをコミットする前に検証します。

  12. [コミット] を選択し、コミットメッセージを入力し、再度 [コミット] を選択します。