生成环境变量

重要

Visual Studio App Center 计划于 2025 年 3 月 31 日停用。 虽然可以继续使用 Visual Studio App Center,直到它完全停用,但你可以考虑迁移到几个建议的替代方法。

详细了解支持时间线和替代方案。

环境变量有助于管理 生成脚本任务。 可以调用预定义的变量或创建自己的变量。

预定义变量

常规变量 说明
APPCENTER_BUILD_ID 当前生成的唯一标识符
APPCENTER_BRANCH 正在从中生成的分支的名称
APPCENTER_SOURCE_DIRECTORY 生成计算机上的源代码位置
APPCENTER_OUTPUT_DIRECTORY 生成结果的存储位置
APPCENTER_TRIGGER 是什么触发了生成,是还是manualcontinuous推送

特定于 iOS
APPCENTER_XCODE_PROJECT 所选 Xcode 项目
APPCENTER_XCODE_SCHEME 选定的 Xcode 方案

Android 特定
APPCENTER_ANDROID_VARIANT 所选 Android 变体
APPCENTER_ANDROID_MODULE 所选 Android 模块

UWP 特定
APPCENTER_UWP_SOLUTION 所选解决方案
APPCENTER_UWP_CONFIGURATION 所选配置

特定于 Xamarin
APPCENTER_XAMARIN_PROJECT 所选项目
APPCENTER_XAMARIN_CONFIGURATION 所选配置

React Native特定
APPCENTER_REACTNATIVE_PACKAGE 所选包

在生成配置中声明的变量

使用自定义环境变量可以定义生成所需的敏感信息,而无需将其签入存储库。 可以在生成配置中创建环境变量,并在生成中使用它们。 例如,访问 API 密钥、Webhook 令牌或其他机密。

注意

保留“平台”作为环境变量使用。

显示处于不同状态的自定义环境变量的生成配置

加密变量

通过单击锁图标来加密变量的值,这会在生成配置 & 日志中对其进行模糊处理。 保存后,加密值不可编辑,但可以在重新创建 & 将其删除。

随时可以加密非加密值。

访问变量

可以在生成过程中使用预先设置的环境变量。 根据所使用的工具集,语法会有所不同。

注意

使用环境变量的正确方法取决于使用的工具链。

生成脚本

生成脚本中,可以使用以下语法访问变量,具体取决于使用的是 Bash 还是 PowerShell。

  • Bash

    $ENVIRONMENT_VARIABLE
    
  • PowerShell

    $env:ENVIRONMENT_VARIABLE
    

Xamarin 或 UWP 的 NuGet.Config

如果要生成 Xamarin 或 UWP 应用,可能需要连接到需要身份验证的专用 NuGet 源。 在 文件中 NuGet.Config ,可以使用定义的变量。 有关文件中凭据 NuGet.Config 用法的更多详细信息,请阅读 参考文档

<packageSourceCredentials>
  <MyAuthNuget>
    <add key="Username" value="%USER_VARIABLE%" />
    <add key="ClearTextPassword" value="%PASSWORD_VARIABLE%" />
  </MyAuthNuget>
</packageSourceCredentials>

build.gradle (Android 应用级别)

对于 Android 应用,可以在 build.gradle (应用级别) 配置中访问变量。有关更多详细信息,请阅读 Gradle 提示和食谱 文档。

buildConfigField("String", "API_KEY", "\"${System.env.API_KEY}\"")