UBA 环境变量

以下表格列出了 Unity Build Automation 的环境变量。

系统

系统环境变量控制系统的行为和已安装资源的位置。所有变量都已设置,可以在预构建和后构建脚本中使用。

变量描述
ANDROID_HOMEAndroid Lib 的本地路径
ANDROID_NDK_ROOTAndroid NDK 根目录的本地路径
BUILDER_OS构建运行的操作系统类型。MAC 或 WINDOWS。
CCD_BINARY_PATH云内容交付二进制可执行文件的本地路径
HOMEDRIVE主驱动器位置
HOMEPATH主目录的相对路径
OUTPUT_DIRECTORY包含构建过程输出的目录的路径
PLASTIC_CLCONFIGURECLIENT_PATHPlastic CLConfigureClient 的路径
PLASTIC_CM_PATHPlastic CLI 的路径
PLATFORM_HOST构建服务 API 的主机。例如/ usersvc-live.cloud.unity3d.com
PROJECT_DIRECTORY要构建的项目的根目录的路径
SCM_MAX_RETRIES在签出源代码时将尝试的最大重试次数
UNITY_EXEUnity 引擎可执行文件的位置
UPM_REGISTRYUnity 包管理器 URL
UPM_SERVER_ENABLED设置为 true 时,默认情况下,将在代理上启动 UPM 服务器
UPM_SERVER_EXEUnity 包管理器服务器可执行文件的路径
UPM_SERVER_PORTUPM 服务器运行的端口
USERPROFILE操作系统上的用户主目录位置
WEBGL_STREAMING_ENABLED设置为 true 时,默认情况下,WebGL 项目的 StreamingAssets 路径将从要存档的路径列表中排除
WORKSPACE代理上创建给定构建目标的所有文件夹的本地路径。例如 /opt/workspace/workspace

构建

构建环境变量与构建的执行相关联并控制构建的执行。以下是常规构建变量的列表。与构建过程的一部分的特定执行相关的构建变量在其部分中分类。一些变量可能在运行 Unity 构建之前未设置。我们建议在尝试使用它们之前检查它们的值。

变量描述
BACKTRACE_ENABLED设置为“true”时,默认情况下,将启用错误回溯记录
BUILD_PLATFORM正在构建的目标类型
BUILD_TARGETUCB 构建目标的 ID
BUILD_REVISION将要构建的源代码的当前修订版本。
BUILDCFG_FILE构建配置文件的本地路径
BUILDCFG_TARGET正在构建的目标的名称(或 ID)
BUILDJOB_CACHE构建完成后要缓存的文件类型。默认值为“library”。只能通过管理 UI 设置为“workspace”。如果使用专用构建器,则设置为 local
CLEAN_BUILD设置为 true 时,不会拉取缓存的库或工作区。使用 git 时,将运行 git clean。使用 Perforce 时,将执行 p4 forcesync。
IS_BUILDER在构建代理上运行时设置为 true。在本地运行时为 false
LOG_VERBOSE将 verbose 选项传递给 xcode 项目时设置为“1”
ORG_IDUCB 组织的 ID
PARENT_BUILD_GUID此构建的主要工件将被下载并重新签名。仅在重新签名已构建的工件时设置
PREVIOUS_SUCCESSFUL_BUILD_REVISION成功构建的目标的最后一个修订版本
PROJECT_IDUCB 项目的 ID
SCM_BRANCH要构建的分支名称
SCM_REVISION要签出的特定提交哈希值。仅在构建配置中指定时设置
SCM_HOST源代码管理器的主机 URL
SCM_USER从 SCM 签出代码的用户名
SKIP_UPLOAD_ARTIFACTS设置为“1”时,将跳过将构建的工件上传到 UCB
UCB_BUILD_NUMBER正在构建的特定目标的构建编号
XCARCHIVE_PATHXcode 存档文件的本地路径,例如/‘~/Library/Developer/Xcode/Archives/something.xcarchive

云内容交付

这些变量仅在 CCD_ENABLED 设置为 true 时才可用,基于构建配置。

变量描述
CCD_BUCKET_ID要将内容上传到的存储桶的 ID。由构建配置定义
CCD_CREATE_RELEASE设置为“true”时,将从存储桶的最新版本创建发布。由构建配置定义。
CCD_ENABLED设置为“true”时,将使用云内容交付。由构建配置定义
CCD_PRESERVE_BUCKET设置为 true 时,不会删除存储桶中的现有内容。由构建配置定义
CCD_STRIP_REMOTE_PATH设置为“true”时,将保留存储桶,并将文件直接上传到根目录,而不是在文件夹级别。由构建配置定义。

Fastlane

Fastlane 环境变量控制 Fastlane 的行为

变量描述
FASTLANE_USER与 Fastlane 一起使用的 App Store Connect / Apple Developer Portal 用户
FASTLANE_VERBOSE设置为“true”时,将在执行触发的 Fastlane 命令时启用详细日志记录。
FL_NOTARIZE_ASC_PROVIDER提供者的 WWDR 团队 ID
FL_NOTARIZE_USE_NOTARYTOOL使用 Xcode 13 时,如果将其设置为 true,则在使用 Fastlane 进行公证时,将使用 Xcode 公证工具
FL_NOTARIZE_USERNAME与 Fastlane 一起使用的 App Store Connect / Apple Developer Portal 用户

Perforce

变量描述
P4_CLEANUPCLIENT设置为“true”时,将在从 Perforce 存储库签出代码时运行 deleteclient
P4_SSL设置为“true”时,P4 在与服务器通信时将使用 SSL
P4CLIENT对 P4 SCM 执行操作时要使用的 P4 客户端
P4PORTP4 SCM 运行的端口
P4USER使用 P4 签出代码的用户名

Unity VCS(以前为 Plastic SCM)

变量描述
PLASTIC_AUTH_TYPE用于对 Plastic SCM 进行身份验证的方法
PLASTIC_ENCRYPTION_METHODPlastic SCM 上的加密类型

Unity

变量描述
MONO_XMLSERIALIZER_THS设置为“No”,这将不使用 Unity 的 Mono 构建的 THS XML 序列化器
UNITY_EXTRA_PARAMS在批处理模式下运行时将传递给 Unity 编辑器的额外参数
UNITY_PLAYER_PATHUnity Player 的本地路径
UNITY_PLAYER_PATH_DATAWindows 或 Mac 构建的 Unity Player Data 文件的本地路径
UNITY_PLAYER_PATH_DEBUG_SYMBOLSAndroid 构建的 Unity Player 调试符号的本地路径
UNITY_PLAYER_PATH_DSYMiOS 构建的 Unity Player 调试符号的本地路径
UNITY_SHADER_COMPILER_RETRY_COUNT设置为“3”。在 Unity 中编译着色器时的重试尝试次数
UNITY_VERSION构建将运行的 Unity 版本
UNITY_VERSION_DIFF如果此构建的 Unity 版本与上次构建不同,则为 True

还有两个基于构建配置和输出的动态配置环境变量。由于它们的工作方式,将提供确定环境变量名称的模式。

变量描述模式
UNITY_PLAYER_PATH_#{architecture}给定体系结构的 Unity Player 文件的本地路径。#{architecture} 代表构建的目标体系结构的占位符值。例如/如果其中一个输出体系结构是 x86,那么环境变量将是 UNITY_PLAYER_PATH_X86
UNITY_PLAYER_PATH_#{obb_file_type}_OBBUnity Player OBB 文件的本地路径#{obb_file_type} 代表各种 OBB 文件的占位符值。例如:如果文件名为 example.file.obb,则环境变量将为 UNITY_PLAYER_PATH_FILE_OBB