创建拉取请求 - Amazon CodeCatalyst

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

创建拉取请求

创建拉取请求有助于在您将代码更改合并到另一分支之前,让其他用户查看和审核您所做的更改。首先,您需要为代码更改创建一个分支,这称作拉取请求的源分支。提交更改并将其推送到存储库后,您可以创建一个拉取请求,将源分支的内容与目标分支的内容进行比较。

您可以在 Amazon CodeCatalyst 控制台中从特定分支、拉取请求页面或项目概述创建拉取请求。从特定分支创建拉取请求会自动在拉取请求创建页面上提供存储库名称和源分支。创建拉取请求时,您将自动收到有关拉取请求的任何更新以及拉取请求何时合并或关闭的电子邮件。

注意

在创建拉取请求时,显示的区别是源分支的尖端和目标分支的尖端之间的区别。创建拉取请求后,显示的区别将是您选择的拉取请求的修订版和创建拉取请求时作为目标分支提示的提交。有关 Git 中的差异和合并基础的更多信息,请参阅 Git 文档git-merge-base中的。

在创建拉取请求时,您可以使用 “为我写描述” 功能,让 Amazon Q 自动创建拉取请求中包含的更改的描述。当您选择此选项时,Amazon Q 会分析包含代码更改的源分支与要合并这些更改的目标分支之间的差异。然后,它总结了这些变化的内容,以及对这些变化的意图和效果的最佳解释。此功能仅在美国西部(俄勒冈)地区适用于 CodeCatalyst 拉取请求。“为我写描述” 功能不适用于链接仓库中的拉取请求。

注意
注意

由 Amazon Bedrock 提供支持: AWS 实现自动滥用检测。由于 “为我写描述”、“创建内容摘要”、“推荐任务”、“使用 Amazon Q 为项目创建或添加功能” 以及 “使用 Amazon Q 开发者代理向 Amazon Q 分配问题” 功能是在 Amazon Bedrock 上构建的,因此用户可以充分利用 Amazon Bedrock 中实施的控制措施来加强安全、保障和负责任地使用人工智能 (AI)。

创建拉取请求
  1. 导航到您的项目。

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

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

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

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

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

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

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

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

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

    提示

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

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

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

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

    注意

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

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

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

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

    注意

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

从分支创建拉取请求
  1. 导航到要在其中创建拉取请求的项目。

  2. 在导航窗格中,选择源存储库,然后选择包含要查看的代码更改的分支的存储库。

  3. 选择默认分支名称旁边的下拉箭头,然后从列表中选择所需的分支。要查看存储库的所有分支,请选择全部查看

  4. 选择 “更多”,然后选择 “创建拉取请求”。

  5. 已为您预先选择存储库和源分支。在 D est ination 分支中,选择审核完代码后要合并的分支。在 P ull requ est 标题中,输入一个标题,该标题将帮助其他项目用户了解必须审阅的内容及其原因。(可选)在拉取请求描述中提供更多信息,例如粘贴中相关问题的链接 CodeCatalyst,或者添加对您所做更改的描述。

    注意

    如果拉取请求的目标分支与工作流程中指定的分支之一匹配,则配置为为拉取请求创建事件运行的工作流程将在拉取请求创建事件后运行。

  6. 查看分支之间的差异。如果未显示任何更改,则分支可能相同,或者您可能为源和目标都选择了相同的分支。

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

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

    注意

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

  9. (可选)在可选审阅者中,选择添加可选审阅者。从项目成员列表中进行选择以添加他们。在将拉取请求合并到目标分支之前,可选的审阅者不必批准更改。

  10. 如果您对拉取请求包含您要审核的更改并包括所需的审阅者感到满意,请选择创建

如果您将任何工作流程配置为在拉取请求中的分支与目标分支匹配的地方运行,则创建拉取请求后,您将在拉取请求详细信息区域的概述中看到有关这些工作流程运行的信息。有关更多信息,请参阅 向工作流程添加触发器