自定义蓝图入门 - Amazon CodeCatalyst

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

自定义蓝图入门

在创建蓝图的过程中,您可以配置蓝图并生成项目资源的预览。每个自定义蓝图都由一个 CodeCatalyst 项目管理,该项目默认包含一个用于发布到空间蓝图目录的工作流程。

在配置自定义蓝图的详细信息时,您还可以选择将蓝图的源代码存储在第三方存储库中,您仍然可以在其中管理自定义蓝图,并利用生命周期管理功能在修改自定义蓝图时保持空间的项目同步。有关更多信息,请参阅 为带有扩展的项目添加功能 CodeCatalyst以蓝图作者的身份参与生命周期管理

如果您已经拥有具有标准化和最佳实践的源存储库,则可以选择将该源存储库转换为自定义蓝图。有关更多信息,请参阅 将源存储库转换为自定义蓝图

先决条件

在创建自定义蓝图之前,请考虑以下要求:

  • 您的 CodeCatalyst 空间必须是企业级别。有关更多信息,请参阅《Amazon CodeCatalyst 管理员指南》中的管理账单

  • 要创建自定义蓝图,您需要拥有 Space 管理员Power 用户角色。有关更多信息,请参阅 使用用户角色授予访问权限

步骤 1:在中创建自定义蓝图 CodeCatalyst

当您根据空间的设置创建自定义蓝图时,系统会为您创建一个存储库。存储库包含在将蓝图发布到空间的蓝图目录之前开发蓝图所必需的所有资源。

创建自定义蓝图

  1. 打开 CodeCatalyst 控制台,网址为 https://codecatalyst.aws/

  2. 在 CodeCatalyst 控制台中,导航到要创建自定义蓝图的空间。

  3. 在太空仪表板上,选择设置选项卡,然后选择蓝图

  4. 选择创建蓝图

  5. 在为蓝图命名下,输入要分配给项目的名称及其关联的资源名称。该名称在空间内必须是唯一的。

  6. (可选)默认情况下,蓝图创建的源代码存储在存储 CodeCatalyst 库中。或者,您可以选择将蓝图的源代码存储在第三方存储库中。有关更多信息,请参阅 为带有扩展的项目添加功能 CodeCatalyst

    根据您要使用的第三方存储库提供商,执行以下任一操作:

    • GitHub 存储库:Connect GitHub 账户。

      选择 “高级” 下拉菜单,选择 GitHub作为存储库提供者,然后选择要存储蓝图创建的源代码的 GitHub 帐户。

      注意

      如果您使用的是 GitHub 账户连接,则必须创建个人连接才能在您的身份和身份之间建立 CodeCatalyst 身份映射。 GitHub 有关更多信息,请参阅 人际关系通过人际关系访问 GitHub 资源

    • Bitbucket 存储库:连接 Bitbucket 工作空间。

      选择 “高级” 下拉菜单,选择 Bitbucket 作为存储库提供程序,然后选择要存储蓝图创建的源代码的 Bitbucket 工作空间。

    • GitLab 存储库:Connect GitLab 用户。

      选择 “高级” 下拉菜单,选择 GitLab作为存储库提供者,然后选择要存储蓝图创建的源代码的 GitLab 用户。

  7. 蓝图详细信息下,执行以下操作:

    1. 蓝图显示名称文本输入字段中,输入一个将出现在空间蓝图目录中的名称。

    2. 描述文本输入字段中,输入自定义蓝图的描述。

    3. 作者姓名文本输入字段中,输入自定义蓝图的作者姓名。

    4. (可选)选择高级设置

      1. 选择 “+ 添加” 以添加添加到package.json文件中的标签。

      2. 选择许可证下拉菜单,然后为自定义蓝图选择许可证。

      3. 蓝图包名称文本输入字段中,输入用于标识您的蓝图包的名称。

      4. 默认情况下,发布工作流程是使用项目中名为 Blueprint Builder 的发布蓝图生成的。由于发布工作流程启用了发布权限,因此当您推送更改时,工作流程会将最新的蓝图版本发布到您的空间。要关闭工作流程生成,请取消选中 “发布工作流程” 复选框。

  8. (可选)蓝图项目附带预定义的代码,用于支持将蓝图发布到空间的蓝图目录中。要根据您选择的项目参数查看包含更新的定义文件,请从 “生成蓝图预览” 中选择 “查看代码” 或 “查看工作流程”。

  9. 选择创建蓝图

如果您没有关闭自定义蓝图的工作流程生成,则在创建蓝图时,工作流程会自动开始运行。工作流程运行完成后,您的自定义蓝图可以默认添加到空间的蓝图目录中。如果您不希望将最新的蓝图版本自动发布到您的空间,则可以关闭发布权限。有关更多信息,请参阅 为自定义蓝图设置发布权限运行工作流

由于名为的发布工作流程blueprint-release是使用蓝图创建的,因此可以在项目中将该蓝图作为已应用的蓝图找到。有关更多信息,请参阅 在项目中添加蓝图以整合资源取消蓝图与项目的关联以停止更新

第 2 步:使用组件开发自定义蓝图

创建自定义蓝图时会生成蓝图向导,开发自定义蓝图时可以使用组件对其进行修改。您可以更新src/blueprints.jssrc/defaults.json文件来修改向导。

重要

如果要使用来自外部来源的蓝图包,请考虑这些包可能带来的风险。您对添加到空间中的自定义蓝图及其生成的代码负责。

在配置蓝图代码之前,使用支持的集成开发环境 (IDE) 在 CodeCatalyst 项目中创建开发环境。开发环境是使用所需工具和软件包所必需的。

创建开发环境

  1. 在导航窗格中,执行以下任一操作:

    1. 选择 “概述”,然后导航到 “我的开发环境” 部分。

    2. 选择 “代码”,然后选择 “开发环境”。

    3. 选择 “代码”,选择 “源存储库”,然后选择您在创建蓝图时创建的存储库。

  2. 选择创建开发环境

  3. 从下拉菜单中选择支持的 IDE。有关更多信息,请参阅开发环境支持的集成开发环境。

  4. 选择在现有分支中工作,然后从现有分支下拉菜单中选择您创建的功能分支。

  5. (可选)在 “别名-可选文本” 输入字段中,输入别名以标识开发环境。

  6. 选择创建。在创建开发环境时,创建开发环境后,“开发环境” 状态列会显示 “正在启动”,状态列显示为 “正在运行”。

有关更多信息,请参阅 使用开发环境编写和修改代码 CodeCatalyst

开发您的自定义蓝图

  1. 在工作终端中,使用以下yarn命令安装依赖项:

    yarn

    所需的工具和包可通过 CodeCatalyst 开发环境(包括 Yarn)获得。如果您在没有开发环境的情况下使用自定义蓝图,请先将 Yarn 安装到您的系统中。有关更多信息,请参阅 Yarn 的安装文档

  2. 开发您的自定义蓝图,使其根据您的喜好进行配置。您可以通过添加组件来修改蓝图的向导。有关更多信息,请参阅 开发自定义蓝图以满足项目要求使用前端向导修改蓝图功能将自定义蓝图发布到空间

步骤 3:预览自定义蓝图

设置和开发自定义蓝图后,您可以预览蓝图的预览版本并将其发布到您的空间。预览版使您能够在蓝图用于创建新项目或将其应用于现有项目之前检查其是否符合您的需求。

预览自定义蓝图

  1. 在工作终端中,使用以下yarn命令:

    yarn blueprint:preview
  2. 导航到提供的See this blueprint at:链接以预览您的自定义蓝图。

  3. 根据您的配置,检查用户界面(包括文本)是否按预期显示。如果要更改自定义蓝图,可以编辑blueprint.ts文件,重新同步蓝图,然后再次发布预览版本。有关更多信息,请参阅 重新合成

(可选)步骤 4:发布自定义蓝图预览版

如果您想将自定义蓝图的预览版添加到空间的蓝图目录中,则可以将其发布到您的空间。这允许您在将非预览版本添加到目录之前以用户身份查看蓝图。预览版允许您在不占用实际版本的情况下进行发布。例如,如果您正在处理某个0.0.1版本,则可以发布和添加预览版本,这样就可以将第二个版本的新更新发布并添加为0.0.2

发布自定义蓝图的预览版

导航到提供的Enable version [version number] at:链接以启用您的自定义蓝图。此链接是在中运行yarn命令时提供的步骤 3:预览自定义蓝图

创建、开发、预览和发布自定义蓝图后,您可以发布最终蓝图版本并将其添加到空间的蓝图目录中。有关更多信息,请参阅 将自定义蓝图发布到空间将自定义蓝图添加到太空蓝图目录