在 Amazon Q 中配置开发文件 - Amazon Q 开发者版

在 Amazon Q 中配置开发文件

要让 Amazon Q 能够测试它为响应 /dev 命令而生成的代码建议，您必须配置开发文件。您可以：

  • 让 Amazon Q 根据项目的上下文为您生成开发文件。

  • 自己创建开发文件。

有关开发文件和使用 Amazon Q 进行测试的更多信息，请参阅测试由 Amazon Q“/dev”命令生成的代码建议。

让 Amazon Q 为您生成开发文件

  1. 在 IDE 中运行 /dev 命令。Amazon Q 会生成一条未经测试的建议，它会在聊天窗口中向您显示该建议。

  2. 在建议的末尾，选择生成开发文件以构建代码按钮。Amazon Q 会生成一个开发文件。

  3. 在项目的根目录文件夹中将文件保存为 devfile.yaml。

    保存开发文件后，Amazon Q 将在下次使用 /dev 命令时开始使用它。

  4. （可选但建议采纳）提交并推送开发文件，以便其他用户可以使用该文件。

配置自己的开发文件

  1. 从基本开发文件开始。您可以让 Amazon Q 为您生成一个开发文件（请参阅前面的过程），也可以使用 Amazon Q 开发者版中的示例开发文件中的示例之一。

  2. 按照下一节Guidelines for configuring your own devfile中的指导，修改开发文件以适合您的需要。

  3. 在项目的根目录文件夹中将文件保存为 devfile.yaml。

    保存开发文件后，Amazon Q 将在下次使用 /dev 命令时开始使用它。

  4. （可选但建议采纳）提交并推送开发文件，以便其他用户可以使用该文件。

配置自己的开发文件的准则

  • 在 image: 中指定的 Docker 映像必须位于公有映像注册表（例如 DockerHub）或公有 Amazon ECR 注册表中。不支持私有注册表。

  • 开发文件必须符合开发文件 2.2.0 架构。

  • 并非开发文件 2.2.0 架构中的所有对象都受支持。Amazon Q 仅支持 install、build 和 test 命令。您可以包含其它命令，但它们不会运行。

  • commands: 中的命令必须在总共不到五分钟的时间内开始运行。它们将在五分钟后超时。

  • 如果您需要引用构件，则这些构件必须位于公有构件存储库中，例如 PyPI 或 npmjs.com。不支持私有构件存储库。

  • 请勿引用需要经过身份验证才能访问的 AWS 资源（或任何资源），例如 Amazon S3 存储桶。这是因为开发环境的 Docker 容器已沙盒化，只能访问互联网上的公有资源。