将自定义蓝图发布到空间 - Amazon CodeCatalyst

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

将自定义蓝图发布到空间

在将自定义蓝图添加到空间的蓝图目录之前,必须将其发布到空间。您也可以在发布之前在 CodeCatalyst 控制台中查看蓝图。您可以发布蓝图的预览版或普通版。

重要

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

重要

要将自定义蓝图发布到您的 CodeCatalyst 空间,您必须使用在空间中具有空间管理员高级用户角色的帐户登录。

查看和发布自定义蓝图的预览版

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

进行更改后,通过运行package.json文件来重建自定义蓝图的软件包,并预览所做的更改。

查看和发布自定义蓝图的预览版

  1. 恢复您的开发环境。有关更多信息,请参阅 恢复开发环境

  2. 在你的开发环境中打开一个可以正常工作的终端。

  3. (可选)在正常运行的终端中,如果您尚未安装项目所需的依赖项,请安装这些依赖项。使用以下命令:

    yarn
  4. (可选)如果您对.projenrc.ts文件进行了更改,请在构建和预览蓝图之前重新生成项目的配置。使用以下命令:

    yarn projen
  5. 使用以下命令重建和预览您的自定义蓝图。使用以下命令:

    yarn blueprint:preview

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

  6. (可选)您可以发布自定义蓝图的预览版,然后将其添加到空间的蓝图目录中。导航到Enable version [preview version number] at:链接,将预览版发布到您的空间。

无需在中创建项目即可模拟项目创建。 CodeCatalyst要合成您的项目,请使用以下命令:

yarn blueprint:synth

蓝图将在synth/synth.[options-name]/proposed-bundle/文件夹中生成。有关更多信息,请参阅 合成

如果您要更新自定义蓝图,请使用以下命令重新同步您的项目:

yarn blueprint:resynth

蓝图将在synth/synth.[options-name]/proposed-bundle/文件夹中生成。有关更多信息,请参阅 重新合成

发布预览版后,您可以添加蓝图,以便空间成员可以使用它来创建新项目或添加现有项目。有关更多信息,请参阅 将自定义蓝图添加到太空蓝图目录

查看和发布自定义蓝图的普通版本

开发和预览自定义蓝图后,您可以查看和发布要添加到空间蓝图目录的新版本。创建项目时生成的发布工作流程会自动发布已推送的更改。如果您在创建蓝图时关闭了工作流程生成,则您的蓝图不会自动添加到空间的蓝图目录中。运行yarn命令后,您仍然可以将自定义蓝图发布到您的空间。

查看和发布自定义蓝图

  1. 恢复您的开发环境。有关更多信息,请参阅 恢复开发环境

  2. 在你的开发环境中打开一个可以正常工作的终端。

    • 如果您在创建蓝图时选择退出发布工作流程生成,请使用以下命令:

      yarn blueprint:release

      您仍然可以导航到提供的See this blueprint at:链接以查看您的自定义蓝图。

      发布自定义蓝图的更新版本,然后将其添加到空间的蓝图目录中。导航到Enable version [release version number] at:链接,将最新版本发布到您的空间。

    • 如果您在创建蓝图时选择了发布工作流程,则在推送更改时会自动发布最新的蓝图版本。使用以下命令:

      git add .
      git commit -m "commit message"
      git push

发布普通版本后,您可以添加蓝图,以便空间成员可以使用它来创建新项目或添加现有项目。有关更多信息,请参阅 将自定义蓝图添加到太空蓝图目录

在指定空间和项目中发布和添加自定义蓝图

默认情况下,blueprint:previewblueprint:release命令会发布到您创建蓝图的 CodeCatalyst 空间中。如果您有多个企业空间,也可以在这些空间中预览和发布相同的蓝图。您也可以将蓝图添加到另一个空间的现有项目中。

在指定空间发布或添加自定义蓝图

  1. 恢复您的开发环境。有关更多信息,请参阅 恢复开发环境

  2. 在你的开发环境中打开一个可以正常工作的终端。

  3. (可选)如果您尚未安装项目所需的依赖项,请安装它们。使用以下命令:

    yarn
  4. 使用--space标签将预览版或普通版发布到指定空间。例如:

    • yarn blueprint:preview --space my-awesome-space # publishes under a "preview" version tag to 'my-awesome-space'

      输出示例:

      Enable version 0.0.1-preview.0 at: https://codecatalyst.aws/spaces/my-awesome-space/blueprints Blueprint applied to [NEW]: https://codecatalyst.aws/spaces/my-awesome-space/blueprints/%40amazon-codecatalyst%2Fmyspace.my-blueprint/publishers/1524817d-a69b-4abe-89a0-0e4a9a6c53b2/versions/0.0.1-preview.0/projects/create
    • yarn blueprint:release --space my-awesome-space # publishes normal version to 'my-awesome-space'

      输出示例:

      Enable version 0.0.1 at: https://codecatalyst.aws/spaces/my-awesome-space/blueprints Blueprint applied to [NEW]: https://codecatalyst.aws/spaces/my-awesome-space/blueprints/%40amazon-codecatalyst%2Fmyspace.my-blueprint/publishers/1524817d-a69b-4abe-89a0-0e4a9a6c53b2/versions/0.0.1/projects/create

    使用--project将自定义蓝图的预览版本添加到指定空间中的现有项目。例如:

    yarn blueprint:preview --space my-awesome-space --project my-project # previews blueprint application to an existing project

    输出示例:

    Enable version 0.0.1-preview.1 at: https://codecatalyst.aws/spaces/my-awesome-space/blueprints Blueprint applied to [my-project]: https://codecatalyst.aws/spaces/my-awesome-space/projects/my-project/blueprints/%40amazon-codecatalyst%2FmySpace.my-blueprint/publishers/1524817d-a69b-4abe-89a0-0e4a9a6c53b2/versions/0.0.1-preview.1/add