开始使用 CodeCatalyst 源存储库和单页应用程序蓝图 - Amazon CodeCatalyst
使用蓝图创建项目查看项目的存储库创建开发环境创建拉取请求合并拉取请求查看已部署的代码清理资源

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

开始使用 CodeCatalyst 源存储库和单页应用程序蓝图

按照本教程中的步骤学习如何在 Amazon 中使用源存储库 CodeCatalyst。

要开始使用 Amazon 中的源存储库，最快的方法 CodeCatalyst 是使用模板创建项目。使用模板创建项目时，会为您创建资源，包括包含示例代码的源存储库。您可以使用此存储库和代码示例来学习如何：

  • 查看项目的源存储库并浏览其内容

  • 使用新分支创建开发环境，您可以在其中处理代码

  • 更改文件，提交并推送您的更改

  • 创建拉取请求并与其他项目成员一起查看您的代码更改

  • 查看项目的工作流程：在拉取请求的源分支中自动生成和测试更改

  • 将源分支中的更改合并到目标分支并关闭拉取请求

  • 查看自动生成和部署的合并更改

要充分利用本教程，请邀请其他人加入您的项目，这样您就可以共同处理拉取请求。您还可以在中探索其他功能 CodeCatalyst，例如创建议题并将其与拉取请求关联，或者配置通知并在关联的工作流程运行时收到提醒。有关全面的探索 CodeCatalyst，请参阅入门教程。

使用蓝图创建项目

创建项目是能够协同工作的第一步。您可以使用蓝图来创建项目，该项目还将创建一个包含示例代码的源存储库和工作流程，该工作流程将在您更改代码时自动生成和部署代码。在本教程中，我们将引导您完成使用单页应用程序蓝图创建的项目，但是对于任何具有源存储库的项目，您都可以按照步骤进行操作。如果您在创建项目时没有IAM角色或添加IAM角色，请务必选择角色或添加角色。我们建议您使用 CodeCatalystWorkflowDevelopmentRole-spaceName此项目的服务角色。

如果你已经有一个项目，你可以直接跳到查看项目的存储库。

注意

只有拥有 Space 管理员或 Power 用户角色的用户才能在中创建项目 CodeCatalyst。如果您没有此角色，并且需要为本教程开发一个项目，请请具有其中一个角色的人为您创建一个项目并将您添加到已创建的项目中。有关更多信息，请参阅 使用用户角色授予访问权限。

使用蓝图创建项目

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

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

  3. 选择 “从蓝图开始”。

    提示

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

    此功能要求为该空间启用生成式 AI 功能。有关更多信息，请参阅管理生成式 AI 功能。

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

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

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

    重要

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

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

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

    • GitHub 存储库：Connect GitHub 账户。

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

      注意

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

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

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

    • GitLab 存储库：Connect GitLab 用户。

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

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

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

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

  10. 选择创建项目。

一旦您创建项目或接受项目邀请并完成登录流程，项目概述页面就会打开。新项目的项目概述页面不包含未解决的问题或拉取请求。您可以选择创建议题并将其分配给自己。您也可以选择邀请其他人加入您的项目。有关更多信息，请参阅在中创建问题 CodeCatalyst 和邀请用户加入项目。

查看项目的存储库

作为项目的成员，您可以查看该项目的源存储库。您也可以选择创建其他存储库。如果拥有 Space 管理员角色的用户安装并配置了GitHub 存储库、Bitbucket 存储库或GitLab 存储库扩展，您还可以在为扩展程序配置的 GitHub 账户、Bitbucket 工作空间或 GitLab 用户中添加指向第三方存储库的链接。有关更多信息，请参阅创建源存储库 和快速入门：安装扩展、连接提供商和链接资源 CodeCatalyst。

注意

对于使用单页应用程序蓝图创建的项目，包含示例代码的源存储库的默认名称为 spa-app.

导航到项目的源存储库

  1. 导航到您的项目，然后执行以下任一操作：

    • 在项目的摘要页面上，从列表中选择所需的存储库，然后选择 “查看存储库”。

    • 在导航窗格中，选择代码，然后选择源存储库。在源存储库中，从列表中选择存储库的名称。您可以通过在筛选栏中键入部分存储库名称来筛选存储库列表。

  2. 在存储库的主页上，查看存储库的内容以及有关关联资源的信息，例如拉取请求的数量和工作流程。默认情况下，会显示默认分支的内容。您可以通过从下拉列表中选择其他分支来更改视图。

存储库的概述页面包含有关为该存储库及其文件分支配置的工作流程和拉取请求的信息。如果您刚刚创建了项目，则构建、测试和部署代码的初始工作流程仍将运行，因为它们需要几分钟才能完成。您可以通过选择 “相关工作流” 下方的数字来查看相关工作流及其状态，但这会在 CI/C D 中打开 “工作流程” 页面。在本教程中，请留在概述页面上浏览存储库中的代码。该README.md文件的内容显示在此页面的存储库文件下方。在 “文件” 中，将显示默认分支的内容。如果您有其他分支，则可以更改文件视图以显示另一个分支的内容。该.codecatalyst文件夹包含用于项目其他部分的代码，例如工作流程YAML文件。

要查看文件夹的内容，请选择文件夹名称旁边的箭头将其展开。例如，选择旁边的箭头src可查看该文件夹中包含的单页 Web 应用程序的文件。要查看某个文件的内容，请从列表中选择该文件。这将打开 “查看文件”，您可以在其中浏览多个文件的内容。你也可以在控制台中编辑单个文件，但要编辑多个文件，你需要创建一个开发环境。

创建开发环境

您可以在 Amazon CodeCatalyst 控制台中添加和更改源存储库中的文件。但是，为了有效地处理多个文件和分支，我们建议使用开发环境或将存储库克隆到本地计算机。在本教程中，我们将创建一个带有名为的分支的 AWS Cloud9 开发环境develop。你可以选择不同的分支名称，但是通过命名分支develop，当你在本教程稍后创建拉取请求时，工作流程将自动运行以生成和测试你的代码。

提示

如果您决定在本地克隆仓库，而不是使用开发环境或在使用开发环境的同时克隆仓库，请确保本地计算机上有 Git 或者IDE包含 Git。有关更多信息，请参阅 为使用源存储库进行设置。

使用新分支创建开发环境

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

  2. 导航到要在其中创建开发环境的项目。

  3. 从项目的源存储库列表中选择存储库的名称。或者，在导航窗格中，选择代码，选择源存储库，然后选择要为其创建开发环境的存储库。

  4. 在存储库主页上，选择 “创建开发环境”。

  5. IDE从下拉菜单中选择支持的。请参阅开发环境支持的集成开发环境了解更多信息。

  6. 选择要克隆的存储库，选择在新分支中工作，在分支名称字段中输入分支名称，然后从创建分支自下拉菜单中选择要从中创建新分支的分支。

  7. 可选操作，为开发环境添加别名。

  8. 可选操作，选择开发环境配置编辑按钮，编辑开发环境的计算、存储或超时配置。

  9. 选择创建。在创建开发环境时，开发环境状态列将显示正在启动，开发环境创建完成后，状态列将显示正在运行。将打开一个新选项卡，其中包含您选择IDE的开发环境。您可以编辑代码并提交和推送更改。

创建开发环境后，您可以编辑文件、提交更改并将更改推送到test分支。在本教程中，编辑src文件夹中App.tsx文件中<p>标签之间的内容以更改网页上显示的文本。提交并推送您的更改，然后返回 CodeCatalyst 选项卡。

在 AWS Cloud9 开发环境中进行和推送更改

  1. 在中 AWS Cloud9，展开侧面导航菜单以浏览文件。展开src并打开App.tsx。

  2. 更改<p>标签内的文本。

  3. 保存文件，然后使用 Git 菜单提交并推送更改。或者，在终端窗口中，使用和git push命令提交git commit并推送您的更改。

    git commit -am "Making an example change"
git push
    提示

    在成功运行 Git 命令之前，您可能需要将终端中的目录更改为 Git 存储库目录。

创建拉取请求

您可以使用拉取请求以协作方式查看代码更改，以了解已发布软件的细微更改或修复、主要功能添加或新版本。在本教程中，您将创建一个拉取请求，以查看您对拉取请求所做的更改 test 分支与主分支相比。在使用模板创建的项目中创建拉取请求也将启动其关联的工作流程（如果有）。

创建拉取请求

  1. 导航到您的项目。

  2. 请执行以下操作之一：

    • 在导航窗格中，选择代码，选择拉取请求，然后选择创建拉取请求。

    • 在存储库主页上，选择 “更多”，然后选择 “创建拉取请求”。

    • 在项目页面上，选择创建拉取请求。

  3. 在源代码库中，确保指定的源存储库是包含已提交代码的存储库。只有在您没有从存储库的主页创建拉取请求时，才会显示此选项。

  4. 在 D est ination 分支中，在查看代码后，选择要将代码合并到的分支。

  5. 在源分支中，选择包含已提交代码的分支。

  6. 在 Pull req uest 标题中，输入一个标题，以帮助其他用户了解需要审阅的内容及其原因。

  7. （可选）在拉取请求描述中，提供诸如问题链接或更改描述之类的信息。

    提示

    你可以选择 “为我写描述”， CodeCatalyst 自动生成拉取请求中包含的更改的描述。将自动生成的描述添加到拉取请求后，您可以对其进行更改。

    此功能要求为空间启用生成式 AI 功能，并且不适用于链接存储库中的拉取请求。有关更多信息，请参阅管理生成式 AI 功能。

  8. （可选）在 “问题” 中，选择 “关联问题”，然后从列表中选择议题或输入其 ID。要取消议题的链接，请选择取消链接图标。

  9. （可选）在必填审稿人中，选择添加所需的审阅者。从项目成员列表中进行选择以添加他们。在将拉取请求合并到目标分支之前，必需的审阅者必须批准更改。

    注意

    您不能将审阅者同时添加为必填审阅者和可选审阅者。您不能将自己添加为审阅者。

  10. （可选）在可选审阅者中，选择添加可选审阅者。从项目成员列表中进行选择以添加他们。在将拉取请求合并到目标分支之前，可选的审阅者不必将更改作为一项要求进行批准。

  11. 查看分支之间的差异。拉取请求中显示的区别在于源分支中的修订版本和合并基础之间的变化，合并基础是创建拉取请求时目标分支的头部提交。如果未显示任何更改，则分支可能相同，或者您可能为源和目标都选择了相同的分支。

  12. 如果您对拉取请求中包含要查看的代码和更改感到满意，请选择 “创建”。

    注意

    创建拉取请求后，您可以添加评论。可以将评论添加到拉取请求或文件中的各个行中，也可以添加到整个拉取请求中。您可以使用 @ 符号和文件名来添加指向资源（例如文件）的链接。

通过选择 “概览”，然后在 “工作流程运行” 下的 “拉取请求详细信息” 区域中查看信息，可以查看有关创建此拉取请求时启动的关联工作流的信息。要查看工作流程运行情况，请选择运行。

提示

如果您将分支命名为以外的其他名称develop，则工作流程将不会自动运行来构建和测试您的更改。如果要对其进行配置，请编辑onPullRequestBuildAndTest工作流程的YAML文件。有关更多信息，请参阅 创建工作流。

您可以对此拉取请求发表评论，并请其他项目成员对此发表评论。您也可以选择添加或更改可选或必填的审阅者。您可以选择对存储库的源分支进行更多更改，并查看这些已提交的更改是如何为拉取请求创建修订的。有关更多信息，请参阅查看拉取请求更新拉取请求、在 Amazon 中使用拉取请求查看代码 CodeCatalyst、和查看工作流程运行状态和详细信息。

合并拉取请求

拉取请求经过审核并获得所需审阅者的批准后，即可在 CodeCatalyst控制台中将其源分支合并到目标分支。合并拉取请求还将通过与目标分支关联的所有工作流程启动更改。在本教程中，您将把测试分支合并到主分支中，这将开始onPushToMainDeployPipeline工作流程的运行。

合并拉取请求（控制台）

  1. 在拉取请求中，选择您在上一步中创建的拉取请求。在拉取请求中，选择合并。

  2. 从拉取请求的可用合并策略中进行选择。（可选）选择或取消选择合并拉取请求后删除源分支的选项，然后选择合并。合并完成后，拉取请求的状态将更改为 “已合并”，并且不再出现在拉取请求的默认视图中。默认视图显示状态为 “打开” 的拉取请求。您仍然可以查看合并的拉取请求，但不能批准它或更改其状态。

    注意

    如果 “合并” 按钮未激活，或者您看到 “不可合并” 标签，则可能是所需的审阅者尚未批准拉取请求，或者拉取请求无法在控制台中合并。 CodeCatalyst 拉取请求详情区域概述中的时钟图标会显示尚未批准拉取请求的审阅者。如果所有必需的审阅者都批准了拉取请求，但合并按钮仍未激活，则可能存在合并冲突，或者已超过空间的存储配额。您可以在开发环境中解决目标分支的合并冲突，推送更改，然后合并拉取请求，也可以解决冲突并在本地合并，然后将包含合并的提交推送到 CodeCatalyst。有关更多信息，请参阅合并拉取请求 (Git)和您的 Git 文档。

查看已部署的代码

现在是时候查看默认分支中最初部署的代码，以及自动构建、测试和部署后合并的更改了。为此，您可以返回存储库的概述页面并选择相关工作流程图标旁边的数字，或者在导航窗格中选择 C I/CD，然后选择 Workflows。

查看已部署的代码

  1. 在 “工作流程” 中onPushToMainDeployPipeline，展开 “最近运行”。

    注意

    这是使用单页应用程序蓝图创建的项目的工作流程的默认名称。

  2. 最近的运行是由你合并的拉取请求提交到main分支开始的，其状态可能会显示为 “进行中”。从列表中选择成功完成的运行以打开该运行的详细信息。

  3. 选择 “变量”。复制 A pp 的值URL。这是URL针对已部署的单页 Web 应用程序的。打开新的浏览器选项卡并粘贴该值以查看已生成和部署的代码。让选项卡保持打开状态。

  4. 返回工作流程运行列表，等待最近一次运行完成。当它出现时，返回您打开的选项卡以查看 Web 应用程序并刷新浏览器。您应该会在合并的拉取请求中看到所做的更改。

清理资源

探索使用源存储库和拉取请求后，您可能需要移除任何不需要的资源。您无法删除拉取请求，但可以将其关闭。您可以删除您创建的任何分支。

如果您不再需要源存储库或项目，也可以删除这些资源。有关更多信息，请参阅删除源存储库 和删除项目。