构建环境中的环境变量 - Amazon CodeBuild
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

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

构建环境中的环境变量

Amazon CodeBuild 提供了您可以在构建命令中使用的多个环境变量:

AWS_DEFAULT_REGION

这些区域有:Amazon运行生成的区域(例如,us-east-1)。此环境变量主要由 Amazon CLI 使用。

AWS_REGION

这些区域有:Amazon运行生成的区域(例如,us-east-1)。此环境变量主要由 Amazon 开发工具包使用。

代码构建批量构建标识符

批量生成中生成的标识符。这是在批处理构建规范中指定的。有关更多信息,请参阅Batch 构建构建规范参考

代码构建 _ 构建 _ ARN

构建的 Amazon 资源名称 (ARN) (例如,arn:aws:codebuild:region-ID:account-ID:build/codebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE)。

代码构建 _ 构建 _ ID

构建的 CodeBuild ID(例如,codebuild-demo-project:b1e6661e-e4f2-4156-9ab9-82a19EXAMPLE)。

代码构建 _ 构建 _ 图像

CodeBuild 映像标识符(例如,aws/codebuild/standard:2.0)。

代码构建 _ 编号

项目的当前构建编号。

代码构建 _ 成功

当前构建是否成功。如果构建失败,设置为 0;如果构建成功,设置为 1

代码构建启动器

启动构建的实体。如果 CodePipeline 启动了生成,那么这就是管道的名称(例如,codepipeline/my-demo-pipeline)。如果 IAM 用户启动了构建,那么这就是用户的名称(例如,MyUserName)。如果适用于 CodeBuild 的 Jenkins 插件启动了构建,那么这就是字符串CodeBuild-Jenkins-Plugin.

代码构建 _ 公司 _ 键 _ ID

其标识符Amazon KMS密钥,CodeBuild 用于加密构建输出项目(例如,arn:aws:kms:region-ID:account-ID:key/key-ID或者alias/key-alias)。

代码生成日志路径

在 CloudWatch 日志中有关构建的日志流名称。

代码构建 _ 公共 _ 构建 _ 网址

此构建在公共构建网站上的构建结果的 URL。仅当构建项目启用了公共版本时才设置此变量。有关更多信息,请参阅

代码构建解析的源版本

构建的源代码的版本标识符。内容取决于源代码存储库:

CodeCommit、GitHub、GitHub Enterprise Server 和 Bitbucket

此变量包含提交 ID。

CodePipeline

此变量包含 CodePipeline 提供的源修订版本。

如果 CodePipeline 无法解析源修订,例如当源是未启用版本控制的 Amazon S3 存储桶时,则不会设置此环境变量。

Amazon S3

未设置此变量。

如果适用,CODEBUILD_RESOLVED_SOURCE_VERSION变量仅在DOWNLOAD_SOURCE阶段。

代码构建 _ 源 _ 回收 _ 网址

输入项目或源代码存储库的 URL。对于 Amazon S3,这是s3://后跟存储桶名称和输入项目的路径。对于 CodeCommit 和 GitHub,这是存储库的克隆 URL。如果构建源自 CodePipeline,则此环境变量可能为空。

对于辅助源,辅助源资料库 URL 的环境变量为CODEBUILD_SOURCE_REPO_URL_<sourceIdentifier>,其中,<sourceIdentifier>是您创建的源标识符。

代码构建 _ 源 _ 版本

值的格式取决于源代码存储库。

  • 对于 Amazon S3,这是与输入项目相关联的版本 ID。

  • 对于 CodeCommit,这是与要生成的源代码的版本相关联的提交 ID 或分支名称。

  • 对于 GitHub、GitHub Enterprise Server 和 Bitbucket,这是与要生成的源代码的版本相关联的提交 ID、分支名称或标签名称。

    注意

    对于由 Webhook 拉取请求事件触发的 GitHub 或 GitHub Enterprise Server 构建,这是 pr/pull-request-number

对于辅助源,辅助源版本的环境变量为CODEBUILD_SOURCE_VERSION_<sourceIdentifier>,其中,<sourceIdentifier>是您创建的源标识符。有关更多信息,请参阅多输入源和输出构件示例

代码构建目录

CodeBuild 用于构建的目录路径 (例如,/tmp/src123456789/src)。

对于辅助源,辅助源目录路径的环境变量为CODEBUILD_SRC_DIR_<sourceIdentifier>,其中,<sourceIdentifier>是您创建的源标识符。有关更多信息,请参阅多输入源和输出构件示例

代码构建开始时间

指定构建为 Unix 时间戳的开始时间(以毫秒为单位)。

代码构建 _ 网络挂钩 _ 角色 _ 帐户 _ ID

触发 Webhook 事件的用户的账户 ID。

代码构建 _ 网络挂钩 _ 基础 _ 参考

触发当前构建的 Webhook 事件的基本引用名称。对于拉取请求,这是分支引用。

代码构建 _ 网络挂钩 _ 事件

触发当前构建的 Webhook 事件。

代码构建 _ 网络挂钩 _ 合并 _ 提交

用于构建的合并提交的标识符。当 Bitbucket 拉请求与 squash 策略合并并且拉取请求分支关闭时设置此变量。在这种情况下,原始拉取请求提交不再存在,因此此环境变量包含压缩合并提交的标识符。

代码构建 _ 网络挂钩 _ 先前提交

在触发当前构建的 Webhook 推送事件之前最新提交的 ID。

代码构建 _ 网络挂钩 _ 头 _ 参考

触发当前构建的 Webhook 事件的头部引用名称。它可以是分支引用或标签引用。

代码构建 _ 网络挂钩 _ 触发器

显示触发构建的 Webhook 事件。此变量仅适用于 Webhook 触发的构建。该值是从通过 GitHub、GitHub Enterprise Server 或 Bitbucket 发送到 CodeBuild 的有效负载解析的。该值的格式取决于触发构建的事件类型。

  • 对于拉取请求触发的构建,这是 pr/pull-request-number

  • 对于通过创建新分支或将提交操作推送到分支而触发的构建,这是 branch/branch-name

  • 对于通过将标签推送到存储库而触发的构建,这是 tag/tag-name

主页

此环境变量始终设置为/root.

您也可以为构建环境提供您自己的环境变量。有关更多信息,请参阅以下主题:

要列出构建环境中的所有可用环境变量,在构建期间,您可以运行 printenv 命令(针对基于 Linux 的构建环境)或 "Get-ChildItem Env:"(针对基于 Windows 的构建环境)。除之前列出的这些变量之外,以CODEBUILD_供 CodeBuild 内部使用。它们不应用于您的构建命令。

重要

我们强烈建议不要使用环境变量存储敏感值,尤其是 Amazon 访问密钥 ID 和秘密访问密钥。使用 CodeBuild 控制台和Amazon CLI.

我们建议您将敏感值存储在 Amazon EC2 Systems Manager 参数存储库中,然后从您的构建规范中检索它们。要存储敏感值,请参阅Systems Manager Parameter Store演练:创建和测试 String 参数(控制台)中的Amazon EC2 Systems Manager 用户指南. 要检索它们,请参阅构建规范语法中的 parameter-store 映射。