GitHub 版 Amazon Q 开发者版(预览版) - Amazon Q 开发者版

GitHub 版 Amazon Q 开发者版(预览版)

注意

GitHub 版 Amazon Q 开发者版目前处于预览发布阶段,功能可能会发生变更。

通过 GitHub 版或 GitHub 企业云版 Amazon Q 开发者版,您可以在软件开发工作流中利用 Amazon Q 开发者版的功能。借助专业的开发代理,您可以实现新想法、审查代码以发现质量问题、通过单元测试解决漏洞,以及对旧版 Java 应用程序进行现代化改造。代理完成任务后,您可以提供反馈,代理会基于之前的解决方案进行迭代优化。有关更多信息,请参阅Amazon Q 开发者版代理

您可以通过 GitHub 访问 Amazon Q 开发者版集成,并授权其访问您所在组织的存储库。要开始使用 GitHub 版 Amazon Q 开发者版,请参阅快速入门:安装、在 GitHub 中使用功能及提高使用限制

重要

要安装 Amazon Q 开发者版应用程序并授权其访问 GitHub 存储库,您必须满足 GitHub 组织的相关要求。有关更多信息,请参阅《GitHub 文档》中的安装 GitHub 应用程序的要求组织中的角色

注意

Amazon Q 开发者版与 GitHub 的集成会在美国境内处理数据。有关更多信息,请参阅 Amazon Q 开发者版中的跨区域处理

注意

适用于 GitHub 的 Amazon Q 开发者版(预览版)目前不会使用您的内容来改进服务。如果我们将来启用此功能,我们将向您提供充分的通知以及供您不选择此类用途的方式。

安装 Amazon Q 开发者版应用程序并授权访问

作为 GitHub 组织管理员,您可以从 GitHub 免费安装和配置 Amazon Q 开发者版应用程序,无需先设置 AWS 账户即可开始使用。在安装过程中,您可以选择向该应用程序授予对 GitHub 组织中所有或选定存储库的访问权限。完成安装和授权后,您就能在 GitHub 中免费使用 Amazon Q 开发者版的功能。若要提升免费使用额度,可在 Amazon Q 开发者版控制台中注册该应用安装。有关更多信息,请参阅快速入门:安装、在 GitHub 中使用功能及提高使用限制

重要

要安装 Amazon Q 开发者版应用程序并授权其访问 GitHub 存储库,您必须满足 GitHub 组织的相关要求。有关更多信息,请参阅《GitHub 文档》中的安装 GitHub 应用程序的要求组织中的角色

注意

如果您的 GitHub 企业组织已启用 IP 允许列表,则必须在 GitHub 应用程序中确认允许的 IP 地址。您也可以选择将这些 IP 地址自动添加到您的允许列表中。有关更多信息,请参阅《GitHub 文档》中的允许 GitHub 应用程序访问启用允许的 IP 地址

以下是用于访问您 GitHub 资源的 IP 地址:

34.228.181.128 44.219.176.187 54.226.244.221

Amazon Q 开发者版代理

Amazon Q 开发者版代理在整个软件开发生命周期中提供支持,涵盖编码、测试、部署、故障排查及应用程序现代化改造等环节。

  • Amazon Q 开发代理:创建问题并添加“功能开发”标签后,Amazon Q 开发者版会自动实现您的新功能和错误修复。Amazon Q 开发者版会创建一个包含代码更改及更改摘要的拉取请求。除应用标签外,您也可以在问题评论中使用 /q dev 斜杠命令来启动功能开发。有关更多信息,请参阅在 GitHub 中使用 Amazon Q 开发者版开发功能并迭代

  • Amazon Q 代码审查代理:当新拉取请求创建或已关闭的拉取请求重新打开时,Amazon Q 开发者版会自动执行代码审查,并针对代码质量、潜在问题及安全隐患提供反馈。Amazon Q 开发者版还会为已识别的问题生成修复方案,您可查看并选择是否将其提交到拉取请求中。代码审查结果包含一份审查摘要,其中按主题分类列出问题。您可在拉取请求的评论中使用 /q 命令与 Amazon Q 开发者版交互,就代码审查中发现的问题提问。

    现有拉取请求内后续提交的代码不会触发自动审查。您可在拉取请求中使用 /q review 斜杠命令启动额外的代码审查。有关更多信息,请参阅在 GitHub 中使用 Amazon Q 开发者版进行代码审查

  • Amazon Q 转换代理:创建问题并添加“代码转换”标签后,Amazon Q 开发者版会将您的代码从 Java 8 或 11 版本转换为 17 版本。Amazon Q 开发者版会创建一个包含代码更改及更改摘要的拉取请求。除应用标签外,您也可以在问题评论中使用 /q transform 斜杠命令来启动代码转换。有关更多信息,请参阅在 GitHub 中使用 Amazon Q 开发者版转换代码

重要

Amazon Q 开发者版应用程序会尝试在您授权访问的 GitHub 存储库中,自动创建 Amazon Q 开发代理Amazon Q 转换代理标签。若这些标签未自动创建或被意外删除,您可在 GitHub 中手动创建。这两个标签的名称必须为 Amazon Q 开发代理Amazon Q 转换代理,才能被 Amazon Q 开发者版识别并处理。有关更多信息,请参阅《GitHub 文档》中的创建标签

注册应用程序安装

Amazon Q 开发者版与 GitHub 的集成可免费使用,无需先设置 AWS 账户即可开始。系统会为您提供每月有限的调用次数(用于功能开发和代码转换),以及每月有限的代码行数(用于代码审查)。若要提升免费使用额度,可将您的 Amazon Q 开发者版应用程序安装与 AWS 账户进行注册绑定。有关更多信息,请参阅在 Amazon Q 开发者版控制台中提高使用限额并配置的详细信息

重要

要在 Amazon Q 开发者版控制台中注册应用程序安装,您必须满足 GitHub 组织的相关要求。有关更多信息,请参阅《GitHub 文档》中的安装 GitHub 应用程序的要求OAuth 应用程序与组织

在中 GitHub 使用浏览器扩展程序

您可以在受支持的浏览器中使用 Amazon Q 开发者版扩展程序,在 GitHub 问题中快速添加“功能开发”或“代码转换”标签,无需在标签菜单中手动查找。

Amazon Q 开发者版扩展程序支持以下浏览器:

在 GitHub 问题和拉取请求中使用斜杠命令

您可以在 GitHub 问题或拉取请求的评论中使用斜杠命令,调用 Amazon Q 开发者版执行开发任务或提供支持。

  • /q dev:在 GitHub 问题中调用 Amazon Q 开发者版,自动实现新功能和错误修复。Amazon Q 开发者版会创建一个包含代码更改及更改摘要的拉取请求。

  • /q review:调用 Amazon Q 开发者版,在拉取请求创建或重新打开时自动执行代码审查。代码审查会针对代码质量、潜在问题及安全隐患提供反馈,同时给出建议修复方案,并生成按主题分类列出问题的审查摘要。在拉取请求评论中使用 /q 可与审查发现的问题进行交互。现有拉取请求后续提交的代码不会触发自动审查。

  • /q transform:当创建问题并添加“代码转换”标签时,调用 Amazon Q 开发者版会自动将 Java 8 或 11 版本代码转换为 Java 17 版本。Amazon Q 开发者版会创建一个包含代码更改及修改摘要的拉取请求。

  • /q help:提供 GitHub 版 Amazon Q 开发者版的相关信息,包括斜杠命令、功能、自定义详情,以及指向《Amazon Q 开发者版指南》GitHub 版 Amazon Q 开发者版(预览版) 文档的链接。