了解构建规范 - AWS Amplify 托管

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

了解构建规范

Amplify 应用程序的构建规范是一系列 YAML 设置和构建命令,Amplify 会使用它们来运行构建。下表描述了这些设置及其使用方式。

版本

Amplify YAML 版本号。

appRoot

此应用程序所在存储库中的路径。除非定义了多个应用程序,否则忽略。

env

向此部分中添加环境变量。您还可以使用控制台添加环境变量。

后端

在持续部署过程中,运行 Amplify CLI 命令来预置后端、更新 Lambda 函数或 GraphQL 架构。

frontend

运行前端构建命令。

测试

在测试阶段运行命令。了解如何为应用程序添加测试

构建阶段

前端和后端都具有三个阶段,表示在每个构建序列中运行的命令。

  • preBuild:预构建脚本在实际构建启动之前、Amplify 安装依赖项之后运行。

  • build – 您的构建命令。

  • postBuild – 构建后脚本在构建已完成并且 Amplify 已将所有必要项目都复制到输出目录后运行。

buildpath

用于运行构建程序的路径。Amplify 使用此路径来查找您的构建构件。如果您没有指定路径,Amplify 会使用单一存储库应用程序根目录,例如 apps/app

artifacts>base-directory

您的构建构建所位于的目录。

artifacts>files

指定要部署的构件中的文件。输入 **/* 以包含所有文件。

cache

指定构建时的依赖项,例如 node_modules 文件夹,并根据应用程序内置的软件包管理器和框架自动推荐。第一次构建时会缓存这里的任何路径,在随后的构建中,我们会重新填充缓存,并尽可能使用这些缓存的依赖项来加快构建时间。

以下构建规范示例演示了基本的 YAML 语法。

version: 1 env: variables: key: value backend: phases: preBuild: commands: - *enter command* build: commands: - *enter command* postBuild: commands: - *enter command* frontend: buildpath: phases: preBuild: commands: - cd react-app - npm ci build: commands: - npm run build artifacts: files: - location - location discard-paths: yes baseDirectory: location cache: paths: - path - path test: phases: preTest: commands: - *enter command* test: commands: - *enter command* postTest: commands: - *enter command* artifacts: files: - location - location configFilePath: *location* baseDirectory: *location*