添加精心策划 GitHub 的动作 - Amazon CodeCatalyst

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

添加精心策划 GitHub 的动作

策划的 GitHub 操作是在 CodeCatalyst 控制台中可用的 GitHub 操作,可作为如何在 CodeCatalyst工作流程中使用 GitHub 操作的示例。

策划的 GitHub 操作被封装在由标识符标识的 CodeCatalyst-authored Actions GitHub 操作中。aws/github-actions-runner@v1例如,精心策划的 Acti GitHub on 如下所示: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.

在前面的代码中,Actions 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. 在导航窗格中,选择 C I/CD,然后选择工作流程。

  4. 选择工作流程的名称。您可以按定义工作流程的源存储库或分支名称进行筛选,也可以按工作流程名称或状态进行筛选。

  5. 选择编辑

  6. 选择 “视觉”。

  7. 在左上角,选择 + 操作以打开操作目录。

  8. 从下拉列表中选择GitHub

  9. 浏览或搜索某项 GitHub 操作,然后执行以下任一操作:

    • 选择加号 (+) 将操作添加到工作流程图中,然后打开其配置窗格。

      Or

    • 选择 GitHub 操作的名称。将出现 “操作详细信息” 对话框。在此对话框中:

      • (可选)选择 “查看源代码” 以查看操作的源代码

      • 选择 “添加到工作流”,将操作添加到工作流程图中,然后打开其配置窗格。

  10. 在 “输入”、“配置” 和 “输出” 选项卡中,根据需要填写字段。有关每个字段的描述,请参阅'GitHub 操作'动作 YAML。本参考提供了有关 “GitHub操作” 操作中可用的每个字段(以及相应的YAML属性值)的详细信息,因为该字段出现在YAML和可视编辑器中。

    有关策划的 Acti GitHub on 可用的配置选项的信息,请参阅其文档。

  11. (可选)选择 “验证” 以在提交之前验证工作流程的YAML代码。

  12. 选择 “提交”,输入提交消息,然后再次选择 “提交”。

YAML
使用编辑器添加精选 GitHub 动作 YAML
  1. 打开 CodeCatalyst 控制台,网址为 https://codecatalyst.aws/

  2. 选择您的项目。

  3. 在导航窗格中,选择 C I/CD,然后选择工作流程。

  4. 选择工作流程的名称。您可以按定义工作流程的源存储库或分支名称进行筛选,也可以按工作流程名称或状态进行筛选。

  5. 选择编辑

  6. 选择YAML

  7. 在左上角,选择 + 操作以打开操作目录。

  8. 从下拉列表中选择GitHub

  9. 浏览或搜索某项 GitHub 操作,然后执行以下任一操作:

    • 选择加号 (+) 将操作添加到工作流程图中,然后打开其配置窗格。

      Or

    • 选择 GitHub 操作的名称。将出现 “操作详细信息” 对话框。在此对话框中:

      • (可选)选择 “查看源代码” 以查看操作的源代码

      • 选择 “添加到工作流”,将操作添加到工作流程图中,然后打开其配置窗格。

  10. 根据需要修改YAML代码中的属性。中提供了对 “GitHub 操作” 操作可用的每个属性的解释'GitHub 操作'动作 YAML

    有关策划的 Acti GitHub on 可用的配置选项的信息,请参阅其文档。

  11. (可选)选择 “验证” 以在提交之前验证工作流程的YAML代码。

  12. 选择 “提交”,输入提交消息,然后再次选择 “提交”。