创建项目 - Amazon CodeCatalyst
创建空项目使用链接的第三方存储库创建项目使用蓝图创建项目使用 Amazon Q 通过蓝图创建项目或添加功能时的最佳实践将蓝图与项目结合使用的最佳实践向已创建的项目添加资源和任务

Amazon CodeCatalyst 不再向新客户开放。现有客户可以继续正常使用该服务。有关更多信息，请参阅 如何从 CodeCatalyst 迁移。

创建项目

利用 CodeCatalyst 项目，您可以使用共享的持续集成/持续交付（CI/CD）工作流和存储库执行开发任务、管理资源、跟踪事务和添加用户。

在创建项目之前，您必须具有空间管理员或高级用户角色。

在 Amazon CodeCatalyst 中创建空项目

您可以创建没有资源的空项目，并在稍后手动添加所需的资源。

在创建项目之前，您必须具有空间管理员或高级用户角色。

创建空项目

  1. 导航到要在其中创建项目的空间。

  2. 在空间控制面板上，选择创建项目。

  3. 选择从头开始。

  4. 在为项目命名下，输入要分配给项目的名称。该名称在空间内必须是唯一的。

  5. 选择创建项目。

使用链接的第三方存储库创建项目

您可以将项目的源代码保留在首选的第三方提供商中，并且仍可使用 CodeCatalyst 的所有功能，例如蓝图、生命周期管理、工作流等。为此，您可以创建一个新的 CodeCatalyst 项目，该项目链接到 GitHub 存储库、Bitbucket 存储库或 GitLab 项目存储库。之后，您可以在 CodeCatalyst 项目中使用链接的源存储库。

在创建 CodeCatalyst 项目之前，您必须具有空间管理员或高级用户角色。有关更多信息，请参阅创建空间和直接邀请用户进入空间 。

要在 CodeCatalyst 中创建一个链接到 GitHub 账户中的源存储库中的项目，您需要完成以下三个任务：

  1. 安装 GitHub 存储库、Bitbucket 存储库或 GitLab 存储库扩展。在外部站点中，系统会提示您连接 CodeCatalyst 并为其提供对您的存储库的访问权限，此操作可在下一步中完成。

    重要

    要将 GitHub 存储库、Bitbucket 存储库或 GitLab 存储库扩展安装到 CodeCatalyst 空间，您必须使用在该空间中具有空间管理员角色的账户进行登录。

  2. 将 GitHub 账户、Bitbucket 工作区或 GitLab 用户连接到 CodeCatalyst。

    重要

    要将您的 GitHub 账户、Bitbucket 工作区、GitLab 用户连接到您的 CodeCatalyst 空间，您必须既是第三方来源的管理员又是 CodeCatalyst 空间管理员。

    重要

    安装存储库扩展后，您链接到 CodeCatalyst 的任何存储库的代码都将存储在 CodeCatalyst 中并建立索引。这样一来，便能在 CodeCatalyst 中搜索代码。要更好地了解在 CodeCatalyst 中使用已链接存储库时对代码实施的数据保护，请参阅《Amazon CodeCatalyst 用户指南》中的数据保护。

  3. 创建一个链接到 GitHub 存储库、Bitbucket 存储库或 GitLab 项目存储库的 CodeCatalyst 项目。

    重要

    您能够以贡献者的身份链接 GitHub 存储库、Bitbucket 存储库或 GitLab 项目存储库，但只能以空间管理员或项目管理员的身份取消链接第三方存储库。有关更多信息，请参阅在 CodeCatalyst 中取消链接 GitHub 存储库、Bitbucket 存储库、GitLab 项目存储库和 Jira 项目。

    重要

    CodeCatalyst 不支持检测已链接存储库的默认分支中的更改。要更改已链接存储库的默认分支，您必须先取消该存储库与 CodeCatalyst 的链接，更改默认分支，然后重新链接该存储库。有关更多信息，请参阅 在 CodeCatalyst 中链接 GitHub 存储库、Bitbucket 存储库、GitLab 项目存储库和 Jira 项目。

    作为最佳实践，在链接存储库之前，请始终确保您拥有最新版本的扩展。

    注意

    • GitHub 存储库、Bitbucket 存储库或 GitLab 项目存储库只能链接到空间中的一个 CodeCatalyst 项目。

    • 您无法在 CodeCatalyst 项目中使用空的或存档的 GitHub 存储库、Bitbucket 存储库或 GitLab 项目存储库。

    • 您无法链接与 CodeCatalyst 项目中的存储库同名的 GitHub 存储库、Bitbucket 存储库或 GitLab 项目存储库。

    • GitHub 存储库扩展与 GitHub Enterprise Server 存储库不兼容。

    • Bitbucket 存储库扩展与 Bitbucket Data Center 存储库不兼容。

    • GitLab 存储库扩展与 GitLab 自行管理的项目存储库不兼容。

    • 您无法在已链接存储库中使用为我编写描述或汇总评论功能。这两项功能仅在 CodeCatalyst 中的拉取请求中可用。

有关更多信息，请参阅 在 CodeCatalyst 中使用扩展向项目添加功能。

安装第三方扩展

  1. 导航到要在其中创建项目的空间。

  2. 在空间控制面板上，选择创建项目。

  3. 选择自带代码。

  4. 在链接现有存储库下，根据要使用的第三方存储库提供商选择 GitHub 存储库、Bitbucket 存储库或 GitLab 存储库。如果您之前未连接您的 GitHub 账户、Bitbucket 工作区或 GitLab 账户，则系统会提示您这样做。如果您选择的第三方扩展尚未安装，系统会显示安装提示。

  5. 如果出现提示，请选择安装。查看扩展所需的权限，如果要继续，请再次选择安装。

安装第三方扩展后，下一步是将您的 GitHub 账户、Bitbucket 工作区或 GitLab 用户连接到您的 CodeCatalyst 空间。

将您的 GitHub 账户、Bitbucket 工作区或 GitLab 用户连接到 CodeCatalyst

根据您选择配置的第三方扩展执行下列操作之一：

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

    1. 选择连接 GitHub 账户以转到 GitHub 的外部站点。

    2. 使用您的 GitHub 凭证登录您的 GitHub 账户，然后选择要在其中安装 Amazon CodeCatalyst 的账户。

      提示

      如果您之前已将 GitHub 账户连接到空间，则系统不会提示您重新授权。相反，将显示一个对话框来询问您要将扩展安装到哪个位置（如果您是多个 GitHub 空间的成员或协作者），或显示 Amazon CodeCatalyst 应用程序的配置页面（如果您只属于一个 GitHub 空间）。为要允许的存储库访问权限配置应用程序，然后选择保存。如果保存按钮未激活，请更改配置，然后重试。

    3. 选择是否要允许 CodeCatalyst 访问所有当前和将来的存储库，或选择要在 CodeCatalyst 中使用的特定 GitHub 存储库。默认选项是在 GitHub 账户中包含所有 GitHub 存储库，包括 CodeCatalyst 将来会访问的存储库。

    4. 查看授予 CodeCatalyst 的权限，然后选择安装。

    在将您的 GitHub 账户连接到 CodeCatalyst 后，您将转至 GitHub 存储库扩展详细信息页面，可在该页面上查看和管理连接的 GitHub 账户和链接的 GitHub 存储库。

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

    1. 选择连接 Bitbucket 工作区以转到 Bitbucket 的外部站点。

    2. 使用您的 Bitbucket 凭证登录您的 Bitbucket 工作区，并查看向 CodeCatalyst 授予的权限。

    3. 从工作区授权下拉菜单中，选择要允许 CodeCatalyst 访问的 Bitbucket 工作区，然后选择授予访问权限。

      提示

      如果您之前已将 Bitbucket 工作区连接到空间，则系统不会提示您重新授权。相反，将显示一个对话框来询问您要将扩展安装到哪个位置（如果您是多个 Bitbucket 工作区的成员或协作者），或显示 Amazon CodeCatalyst 应用程序的配置页面（如果您只属于一个 Bitbucket 工作区）。为要允许的工作区访问权限配置应用程序，然后选择授予访问权限。如果授予访问权限按钮未激活，请更改配置，然后重试。

    在将您的 Bitbucket 工作区连接到 CodeCatalyst 后，您将转至 Bitbucket 存储库扩展详细信息页面，可在该页面上查看和管理连接的 Bitbucket 工作区和链接的 Bitbucket 存储库。

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

    1. 选择连接 GitLab 用户以转到 GitLab 的外部站点。

    2. 使用您的 GitLab 凭证登录您的 GitLab 用户并查看向 CodeCatalyst 授予的权限。

      提示

      如果您之前已将 GitLab 用户连接到空间，则系统不会提示您重新授权。相反，您将导航回到 CodeCatalyst 控制台。

    3. 选择授权 AWS Connector for GitLab。

    在将您的 GitLab 用户连接到 CodeCatalyst 后，您将转至 GitLab 存储库扩展详细信息页面，可在该页面上查看和管理连接的 GitLab 用户和链接的 GitLab 项目存储库。

将第三方来源连接到 CodeCatalyst 后，您可以将第三方存储库链接到您的 CodeCatalyst 项目。

创建您的项目

  1. 在创建项目页面上，选择已连接的 GitHub 账户。

  2. 根据已连接的第三方存储库提供商，选择 GitHub 存储库、Bitbucket 存储库或 GitLab 存储库存储库下拉菜单以查看第三方存储库，然后选择要链接到项目的存储库。

  3. 在命名项目文本输入字段中，输入要分配给项目的名称。该名称在空间内必须是唯一的。

  4. 选择创建项目。

在安装 GitHub 存储库、Bitbucket 存储库或 GitLab 存储库扩展、连接资源提供程序并将第三方存储库链接到 CodeCatalyst 项目后，您可以在 CodeCatalyst 工作流和开发环境中使用它。您还可以使用从蓝图生成的代码在已连接的 GitHub 账户、Bitbucket 工作区或 GitLab 用户中创建第三方存储库。您还可以将已链接存储库与 Amazon Q 开发者版、蓝图等结合使用。有关更多信息，请参阅在第三方存储库事件发生后自动启动工作流运行和创建开发环境。

使用蓝图创建项目

您可以使用项目蓝图预置所有项目资源和示例代码。有关蓝图的信息，请参阅使用 CodeCatalyst 蓝图创建综合项目。

使用蓝图创建项目

  1. 在 CodeCatalyst 控制台中，导航到要在其中创建项目的空间。

  2. 在空间控制面板上，选择创建项目。

  3. 选择从蓝图开始。

    提示

    您可以选择向 Amazon Q 提供您的项目需求，让 Amazon Q 为您推荐蓝图，以此来添加蓝图。有关更多信息，请参阅创建项目或添加功能时使用 Amazon Q 选择蓝图和使用 Amazon Q 通过蓝图创建项目或添加功能时的最佳实践。此功能仅在美国西部（俄勒冈州）区域中提供。

    此功能要求为空间启用生成式人工智能功能。有关更多信息，请参阅 Managing generative AI features。

  4. 从 CodeCatalyst 蓝图或空间蓝图选项卡中选择一个蓝图，然后选择下一步。

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

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

    重要

    CodeCatalyst 不支持检测已链接存储库的默认分支中的更改。要更改已链接存储库的默认分支，您必须先取消该存储库与 CodeCatalyst 的链接，更改默认分支，然后重新链接该存储库。有关更多信息，请参阅 在 CodeCatalyst 中链接 GitHub 存储库、Bitbucket 存储库、GitLab 项目存储库和 Jira 项目。

    作为最佳实践，在链接存储库之前，请始终确保您拥有最新版本的扩展。

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

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

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

      注意

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

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

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

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

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

  7. 在项目资源下，配置蓝图参数。根据蓝图的不同，您可以选择命名源存储库名称。

  8. （可选）要根据您选择的项目参数查看包含更新的定义文件，请从生成项目预览中选择查看代码或查看工作流。

  9. （可选）从蓝图卡中选择查看详细信息，查看蓝图的具体详细信息，如蓝图架构概述、所需连接和权限，以及蓝图创建的资源种类。

  10. 选择创建项目。

使用 Amazon Q 通过蓝图创建项目或添加功能时的最佳实践

在创建项目或需要向现有项目添加新组件时，您可能不确定要使用哪个蓝图或如何集成功能。CodeCatalyst 包含与名为 Amazon Q 的生成式人工智能助手的集成，该助手可以分析您的项目要求并建议一个最能满足您需求的蓝图。

您可以使用 Amazon Q 来帮助您创建带蓝图的项目，该蓝图可以根据您的要求创建组件，或者您可以使用 Amazon Q 来帮助您将蓝图添加到现有项目中。例如，要将适用于 Web 应用程序或现代应用程序的资源添加到项目，请指定您的要求，之后这些资源将与建议的蓝图一起添加。可以为您创建其余组件的事务。

Amazon Q 还会针对建议的蓝图无法满足的要求创建事务。此外，您可以将这些事务分配给 Amazon Q。如果您将事务分配给 Amazon Q，它将尝试创建解决方案草稿以供您评估。这有助于您和您的团队专注于并优化处理需要关注的事务，而 Amazon Q 则专注于解决您没有资源来立即解决的问题。

注意

由 Amazon Bedrock 提供支持：AWS 实施自动化滥用检测。由于为我编写描述、创建内容摘要、推荐任务、使用 Amazon Q 创建功能或将功添加到项目以及将事务分配给 Amazon Q 功能与用于软件开发的 Amazon Q 开发者版代理程序的功能都是基于 Amazon Bedrock 构建的，因此，用户可以充分利用 Amazon Bedrock 中实施的控制措施来强制实施安全性并负责任地使用人工智能（AI）。

以下是一些最佳实践，可帮助您使用 Amazon Q 创建项目和添加蓝图。

重要

生成式人工智能功能仅在美国西部（俄勒冈州）区域中可用。

  • 使用 Amazon Q 提供的默认提示。Amazon Q 非常适合根据提供的提示选择蓝图。

  • 使用 Amazon Q 建议的配置选项来预览蓝图。选择一个蓝图以预览该蓝图将创建的示例代码和资源。

  • 使用为 Amazon Q 启用的空间。要使用 Amazon Q 创建项目，或使用 Amazon Q 向带蓝图的项目添加功能，请使用为生成式人工智能功能启用的空间。有关更多信息，请参阅 Enabling or disabling generative AI features for a space。

  • 获取有关 Amazon Q 建议的蓝图的更多信息。您可能需要详细了解使用建议的特定蓝图创建的项目资源、示例代码和组件的类型。有关 CodeCatalyst 中可用的蓝图的更多信息，请参阅使用 CodeCatalyst 蓝图创建综合项目。

  • 允许 Amazon Q 处理事务。允许 Amazon Q 为您创建事务、分配这些事务并对其进行跟踪。有关更多信息，请参阅 教程：使用 CodeCatalyst 生成式人工智能功能来加快开发工作。

  • 取消向 Amazon Q 分配不再处理的事务。完成示例后，取消向 Amazon Q 分配不再处理的任何事务。如果 Amazon Q 已完成对某个事务的处理或找不到解决方案，请务必取消分配 Amazon Q，以免达到生成式人工智能功能的最大配额。有关更多信息，请参阅 Managing generative AI features 和 Pricing。

  • 查看 Amazon Q 的使用情况。您可以在用户级别查看生成式人工智能功能的使用情况。转到我的设置以管理生成式人工智能配额，并按您的构建者 ID 或单点登录（SSO）身份查看使用情况。有关更多信息，请参阅 Viewing usage of generative AI features in a space。

重要

CodeCatalyst 中的生成式人工智能功能受配额限制。有关更多信息，请参阅 Amazon Q 开发者版定价、Enabling or disabling generative AI features for a space 和 Billing。

将蓝图与项目结合使用的最佳实践

以下是一些最佳实践，可帮助您使用蓝图创建项目或添加蓝图。

  • 使用 CodeCatalyst 提供的蓝图来创建项目或将该蓝图添加到项目中。您可以使用蓝图为开发人员创建包含源代码和资源的完整项目。例如，Web 应用程序蓝图创建应用程序和基础设施资源并部署 Web 应用程序。您可以使用蓝图创建项目，或将自定义蓝图添加到现有项目中。有关更多信息，请参阅 使用蓝图创建项目。在 CodeCatalyst 中查看任意蓝图以预览该蓝图将创建的示例代码和资源。

  • 使用您的组织设计的自定义蓝图。您可以使用自定义蓝图在空间中创建完整项目。您的组织设计的自定义蓝图可以提供标准化和最佳实践，这也有助于减少设置新项目所需的工作量。作为自定义蓝图作者，您可以详细了解哪些项目正在空间中使用您的蓝图。利用生命周期管理功能，您可以集中管理每个项目的软件开发生命周期，并且蓝图用户可以利用生命周期管理功能从蓝图的更新选项或版本中重新生成代码库。有关更多信息，请参阅 以蓝图作者的身份使用生命周期管理功能。

  • 将开发人员角色或相应的 IAM 角色添加到您项目的账户。在完成项目创建步骤期间或之后，您可以通过在已连接到空间的 AWS 账户中选择或创建 IAM 角色来配置蓝图权限。

向已创建的项目添加资源和任务

在项目准备就绪后，您可以添加资源和任务。