新增策劃的 GitHub 動作 - Amazon CodeCatalyst

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

新增策劃的 GitHub 動作

策劃的「 GitHub 動作」是可在 CodeCatalyst 主控台中使用的「 GitHub 動作」,可做為如何在工作 CodeCatalyst流程中使用「 GitHub 動作」的範例。

「已編寫的動作」動 GitHub 作會包裝在由識別 CodeCatalyst元識別的「已編寫的GitHub 動作」動作aws/github-actions-runner@v1。例如,以下是策劃的 GitHub 動作 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 「動作」動作 (由識別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 動作新增至工作流程,請遵循下列步驟。有關在工作 CodeCatalyst 流程中使用 GitHub 「動作」的一般資訊,請參閱與 GitHub 動作整合

注意

如果您在已策劃的 GitHub 動作清單中沒有看到您的「動作」,您仍然可以使用「動作」動作將其新增至工GitHub 作流程。如需詳細資訊,請參閱 添加「GitHub 操作」操作

Visual
若要使用視覺化編輯器新增策劃的 GitHub 動作
  1. 請在以下位置開啟 CodeCatalyst 主控台。 https://codecatalyst.aws/

  2. 選擇您的專案。

  3. 在瀏覽窗格中,選擇 CI/CD,然後選擇 [工作流程]。

  4. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選,或依工作流程名稱或狀態進行篩選。

  5. 選擇編輯

  6. 選擇 [視覺]。

  7. 選擇左上角的 [+ 動作] 以開啟動作目錄。

  8. 從下拉式清單中選擇GitHub

  9. 瀏覽或搜尋「 GitHub 動作」,然後執行下列任一項作業:

    • 選擇加號 (+) 以將動作新增至工作流程圖,並開啟其設定窗格。

    • 選擇「 GitHub 動作」的名稱。動作詳細資訊對話方塊隨即出現。在此對話方塊中:

      • (選擇性) 選擇「檢視原始碼」以檢視動作的原始程式碼

      • 選擇 [新增至工作流程] 以將動作新增至工作流程圖表,並開啟其組態窗格。

  10. 在 [入]、[組態] 和 [輸出] 索引標籤中,根據您的需求完成欄位。如需每個欄位的描述,請參閱'GitHub 動作' 動作 YAML。此參考提供有關「動作」動GitHub作可用之每個欄位 (以及對應YAML屬性值) 的詳細資訊,就像它同時顯示在YAML和可視化編輯器中時。

    如需策劃 GitHub動作可用之組態選項的相關資訊,請參閱其說明文件。

  11. (選擇性) 選擇「驗證」,在確認之前驗證工作流程的程YAML式碼。

  12. 選擇「確認」,輸入確認訊息,然後再次選擇「確認」。

YAML
若要使用YAML編輯器新增策劃的 GitHub 動作
  1. 請在以下位置開啟 CodeCatalyst 主控台。 https://codecatalyst.aws/

  2. 選擇您的專案。

  3. 在瀏覽窗格中,選擇 CI/CD,然後選擇 [工作流程]。

  4. 選擇工作流程的名稱。您可以依定義工作流程的來源儲存庫或分支名稱進行篩選,或依工作流程名稱或狀態進行篩選。

  5. 選擇編輯

  6. 選擇YAML

  7. 選擇左上角的 [+ 動作] 以開啟動作目錄。

  8. 從下拉式清單中選擇GitHub

  9. 瀏覽或搜尋「 GitHub 動作」,然後執行下列任一項作業:

    • 選擇加號 (+) 以將動作新增至工作流程圖,並開啟其設定窗格。

    • 選擇「 GitHub 動作」的名稱。動作詳細資訊對話方塊隨即出現。在此對話方塊中:

      • (選擇性) 選擇「檢視原始碼」以檢視動作的原始程式碼

      • 選擇 [新增至工作流程] 以將動作新增至工作流程圖表,並開啟其組態窗格。

  10. 根據您的需要修改YAML代碼中的屬性。中提供了 GitHub 「動作」動作可用之每個屬性的說明'GitHub 動作' 動作 YAML

    如需策劃 GitHub動作可用之組態選項的相關資訊,請參閱其說明文件。

  11. (選擇性) 選擇「驗證」,在確認之前驗證工作流程的程YAML式碼。

  12. 選擇「確認」,輸入確認訊息,然後再次選擇「確認」。