GitHub キュレーションされたアクションの追加

GitHub GitHub CodeCatalyst キュレーションされたアクションはコンソールに表示されるアクションで、 GitHub ワークフロー内でアクションを使用する方法の例として役立ちます。 CodeCatalyst

GitHub キュレーションされたアクションは、識別子で識別される CodeCatalyst-authored GitHub Actions アクションにまとめられます。aws/github-actions-runner@v1たとえば、 GitHub キュレーションされたアクション OSS は以下のようになります。TruffleHog


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 アクションアクション (で識別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 精選されたアクションをワークフローに追加するには、以下の手順に従います。 GitHub CodeCatalyst ワークフローでのアクションの使用に関する一般的な情報については、を参照してくださいワークフローへの GitHub アクションの統合。

注記

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

Visual

GitHub ビジュアルエディターを使用してキュレーションされたアクションを追加するには

https://codecatalyst.aws/ CodeCatalyst でコンソールを開きます。
プロジェクトを選択します。
ナビゲーションペインで [CI/CD] を選択し、[ワークフロー] を選択します。
ワークフローの名前を選択します。ワークフローが定義されているソースリポジトリまたはブランチ名でフィルタリングすることも、ワークフロー名でフィルタリングすることもできます。
[編集] を選択します。
「ビジュアル」を選択します。
左上の [+ Actions] を選択してアクションカタログを開きます。
ドロップダウンリストから、を選択しますGitHub。
GitHub アクションを参照または検索し、次のいずれかを実行します。
- プラス記号 (+) を選択してアクションをワークフロー図に追加し、設定ペインを開きます。
  
  または
- GitHub アクションの名前を選択します。アクションの詳細ダイアログボックスが表示されます。このダイアログボックスでは:
  - (オプション) アクションのソースコードを表示するには、「ソースを表示」を選択します。
  - 「ワークフローに追加」を選択してアクションをワークフロー図に追加し、設定ペインを開きます。
「入力」、「設定」、「出力」の各タブで、必要に応じてフィールドを入力します。各フィールドの説明については、を参照してくださいGitHub 「アクション」アクション YAML 定義。このリファレンスでは、YAML GitHubエディタとビジュアルエディタの両方に表示されるアクションアクションで使用できる各フィールド (および対応する YAML プロパティ値) に関する詳細情報を提供します。

GitHubキュレーションされたアクションで使用できる設定オプションについては、そのアクションのドキュメントを参照してください。
(オプション)「検証」を選択して、コミットする前にワークフローの YAML コードを検証します。
[Commit] を選択し、コミットメッセージを入力して、もう一度 [Commit] を選択します。

YAML

YAML GitHub エディターを使用してキュレーションされたアクションを追加するには

https://codecatalyst.aws/ CodeCatalyst でコンソールを開きます。
プロジェクトを選択します。
ナビゲーションペインで [CI/CD] を選択し、[ワークフロー] を選択します。
ワークフローの名前を選択します。ワークフローが定義されているソースリポジトリまたはブランチ名でフィルタリングすることも、ワークフロー名でフィルタリングすることもできます。
[編集] を選択します。
YAML を選択します。
左上の [+ Actions] を選択してアクションカタログを開きます。
ドロップダウンリストから、を選択しますGitHub。
GitHub アクションを参照または検索し、次のいずれかを実行します。
- プラス記号 (+) を選択してアクションをワークフロー図に追加し、設定ペインを開きます。
  
  または
- GitHub アクションの名前を選択します。アクションの詳細ダイアログボックスが表示されます。このダイアログボックスでは:
  - (オプション) アクションのソースコードを表示するには、「ソースを表示」を選択します。
  - 「ワークフローに追加」を選択してアクションをワークフロー図に追加し、設定ペインを開きます。
YAML コードのプロパティを必要に応じて変更します。GitHub Actions アクションで使用できる各プロパティの説明は、に記載されています。GitHub 「アクション」アクション YAML 定義

GitHubキュレーションされたアクションで使用できる設定オプションについては、そのアクションのドキュメントを参照してください。
(オプション)「検証」を選択して、コミットする前にワークフローの YAML コードを検証します。
[Commit] を選択し、コミットメッセージを入力して、もう一度 [Commit] を選択します。

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

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

ドキュメントの表記規則

「GitHub アクション」アクションの追加

GitHub 出力パラメータのエクスポート