开始使用自定义蓝图 - Amazon CodeCatalyst
先决条件步骤 1：在 CodeCatalyst 中创建自定义蓝图步骤 2：使用组件开发自定义蓝图步骤 3：预览自定义蓝图（可选）步骤 4：发布自定义蓝图预览版

开始使用自定义蓝图

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

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

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

先决条件

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

  • 您的 CodeCatalyst 空间必须是企业级别。有关更多信息，请参阅《Amazon CodeCatalyst Administrator Guide》中的 Managing billing。

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

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

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

创建自定义蓝图

  1. 通过访问 https://codecatalyst.aws/ 打开 CodeCatalyst 控制台。

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

  3. 在空间控制面板上，选择设置选项卡，然后选择蓝图。

  4. 选择创建蓝图。

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

  6. （可选）默认情况下，蓝图创建的源代码存储在 CodeCatalyst 存储库中。此外，您可以选择将蓝图源代码存储在第三方存储库中。有关更多信息，请参阅在 CodeCatalyst 中使用扩展向项目添加功能。

    根据要使用的第三方存储库提供商，执行以下操作之一：

    • GitHub 存储库：连接 GitHub 账户。

      选择高级下拉菜单，选择 GitHub 作为存储库提供商，然后选择用于存储蓝图所创建的源代码的 GitHub 账户。

      注意

      如果您使用与 GitHub 账户的连接，则必须创建个人连接，以便在您的 CodeCatalyst 身份与 GitHub 身份之间建立身份映射。有关更多信息，请参阅个人连接和使用个人连接访问 GitHub 资源。

    • Bitbucket 存储库：连接 Bitbucket 工作区。

      选择高级下拉菜单，选择 Bitbucket 作为存储库提供商，然后选择用于存储蓝图所创建的源代码的 Bitbucket 工作区。

    • GitLab 存储库：连接 GitLab 用户。

      选择高级下拉菜单，选择 GitLab 作为存储库提供商，然后选择用于存储蓝图所创建的源代码的 GitLab 用户。

  7. 在蓝图详细信息下，执行以下操作：

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

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

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

    4. （可选）选择高级设置。

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

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

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

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

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

  9. 选择创建蓝图。

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

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

步骤 2：使用组件开发自定义蓝图

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

重要

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

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

创建开发环境

  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: 链接以启用您的自定义蓝图。此链接是在步骤 3：预览自定义蓝图中运行 yarn 命令时提供的。

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