使用工作流程构建、测试和部署 - Amazon CodeCatalyst

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

使用工作流程构建、测试和部署

CodeCatalyst开发环境中编写应用程序代码并将其推送到CodeCatalyst 源存储库后,就可以部署它了。自动执行此操作的方法是通过工作流程。

工作流程是一个自动化过程,它描述了如何构建、测试和部署您的代码,作为持续集成和持续交付 (CI/CD) 系统的一部分。工作流程定义了在工作流程运行期间要执行的一系列步骤或操作。工作流程还定义了导致工作流程启动的事件或触发器。要设置工作流程,您可以使用 CodeCatalyst 控制台的视觉对象或YAML编辑器创建工作流程定义文件

提示

要快速了解如何在项目中使用工作流程,请使用蓝图创建一个项目。每个蓝图都部署了一个可以正常运行的工作流程,您可以对其进行查看、运行和试验。

关于工作流程定义文件

工作流程定义YAML文件是描述您的工作流程的文件。默认情况下,该文件存储在源存储库根目录下的~/.codecatalyst/workflows/文件夹中。该文件可以具有.yml 或.yaml 扩展名,并且扩展名必须为小写。

以下是一个简单的工作流程定义文件示例。我们将在下表中解释此示例的每一行。

Name: MyWorkflow SchemaVersion: 1.0 RunMode: QUEUED Triggers: - Type: PUSH Branches: - main Actions: Build: Identifier: aws/build@v1 Inputs: Sources: - WorkflowSource Configuration: Steps: - Run: docker build -t MyApp:latest .
描述
Name: MyWorkflow

指定工作流程的名称。有关该Name属性的更多信息,请参阅顶级属性

SchemaVersion: 1.0

指定工作流程架构版本。有关该SchemaVersion属性的更多信息,请参阅顶级属性

RunMode: QUEUED

表示如何 CodeCatalyst 处理多次运行。有关运行模式的更多信息,请参阅配置运行的排队行为

Triggers:

指定将导致工作流程运行启动的逻辑。有关触发器的更多信息,请参阅启动工作流程使用触发器自动运行

- Type: PUSH Branches: - main

表示每当您将代码推送到默认源存储库的main分支时,工作流程都必须启动。有关工作流程来源的更多信息,请参阅将源存储库连接到工作流程

Actions:

定义工作流程运行期间要执行的任务。在此示例中,该Actions部分定义了一个名为的操作Build。有关操作的更多信息,请参阅配置工作流程操作

Build:

定义动Build作的属性。有关生成操作的更多信息,请参阅使用工作流程进行构建

Identifier: aws/build@v1

为生成操作指定唯一的硬编码标识符。

Inputs: Sources: - WorkflowSource

表示生成操作应在WorkflowSource源存储库中查找完成处理所需的文件。有关更多信息,请参阅 将源存储库连接到工作流程

Configuration:

包含特定于生成操作的配置属性。

Steps: - Run: docker build -t MyApp:latest .

告诉编译操作构建名为的 Docker 镜像MyApp并使用latest标记。

有关工作流定义文件中所有可用属性的完整列表,请参阅工作流程YAML定义

使用 CodeCatalyst 控制台的视觉效果和YAML编辑器

要创建和编辑工作流程定义文件,您可以使用首选编辑器,但我们建议使用 CodeCatalyst 控制台的可视化编辑器或YAML编辑器。这些编辑器提供有用的文件验证,有助于确保YAML属性名称、值、嵌套、间距、大小写等正确无误。

下图显示了可视化编辑器中的工作流程。可视化编辑器为您提供了一个完整的用户界面,您可以通过该界面创建和配置工作流程定义文件。可视化编辑器包括显示工作流程主要组件的工作流程图 (1) 和配置区域 (2)。

工作流程可视化编辑器

或者,您可以使用下图所示的YAML编辑器。使用YAML编辑器粘贴大型代码块(例如教程中的代码),或者添加可视化编辑器未提供的高级属性。

工作流程YAML编辑器

您可以从可视化编辑器切换到YAML编辑器,以查看您的配置对底层YAML代码的影响。

发现工作流程

您可以在工作流程摘要页面上查看您的工作流程,以及您在同一项目中设置的其他工作流程。

下图显示了工作流程摘要页面。它包含两个工作流程:BuildToProdUnitTests。你可以看到两者都运行过几次。您可以选择 “最近运行” 以快速查看运行历史记录,也可以选择工作流程名称以查看工作流程的YAML代码和其他详细信息。

工作流程日志

查看工作流程运行详情

您可以通过在工作流程摘要页面中选择运行来查看工作流程运行的详细信息。

下图显示了名为 run-cc11d 的工作流程运行的详细信息,该工作流程是在提交源代码时自动启动的。工作流程图表明某项操作已失败 (1)。您可以导航到日志 (2) 以查看详细的日志消息并对问题进行故障排除。有关工作流程运行的更多信息,请参阅运行工作流

工作流程日志

后续步骤

要了解有关工作流程概念的更多信息,请参阅工作流程概念

要创建您的第一个工作流程,请参阅工作流程入门