生成、测试和部署 Android 应用
Azure DevOps Services
可以设置管道以自动生成、测试和部署 Android 应用程序。
先决条件
必须具备以下项:
设置管道
执行以下任务,为示例 Android 应用程序设置管道。
将以下存储库分叉到你的 GitHub 帐户,以获取一个简单 Android 应用程序的代码。
https://github.com/MicrosoftDocs/pipelines-android
登录到你的 Azure DevOps 组织,并转到你的项目。
选择“管道”>“创建管道”或“新建管道”。
选择“GitHub”作为源代码位置。
可能会重定向到 GitHub 进行登录。 如果是这样,请输入 GitHub 凭据。
选择之前分叉的 -android 存储库。
在随后出现的屏幕上选择“批准并安装”。
Azure Pipelines 将为你的管道生成 YAML 文件。
选择“运行”。
直接提交到主分支,然后再次选择“运行”。
等待运行完成。
存储库中有一个可供自定义的工作 YAML 文件 (azure-pipelines.yml
)。
提示
若要更改 YAML 文件,请在“管道”页中选择管道,然后编辑 azure-pipelines.yml
文件。
使用 Gradle 进行生成
Gradle 是用于生成 Android 项目的常用生成工具。 有关选项的详细信息,请参阅 Gradle 任务。
# https://learn.microsoft.com/azure/devops/pipelines/ecosystems/android
pool:
vmImage: 'macOS-latest'
steps:
- task: Gradle@2
inputs:
workingDirectory: ''
gradleWrapperFile: 'gradlew'
gradleOptions: '-Xmx3072m'
publishJUnitResults: false
testResultsFiles: '**/TEST-*.xml'
tasks: 'assembleDebug'
调整生成路径
如果
gradlew
文件不在存储库的根目录中,请调整 workingDirectory 值。 目录值应类似于存储库的根目录,例如AndroidApps/MyApp
或$(system.defaultWorkingDirectory)/AndroidApps/MyApp
。如果
gradlew
文件不在存储库的根目录中,请调整 gradleWrapperFile 值。 文件路径值应类似于存储库的根目录,例如AndroidApps/MyApp/gradlew
或$(system.defaultWorkingDirectory)/AndroidApps/MyApp/gradlew
。
调整 Gradle 任务
调整所需生成变体的 tasks 值,例如 assembleDebug
或 assembleRelease
。
有关详细信息,请参阅以下 Google Android 开发文档:
签名并对齐 Android 包 (APK)
如果你的生成尚未对 APK 进行签名和压缩对齐,请将 Android 签名任务添加到 YAML。 APK 必须经过签名才能在设备(而不是模拟器)上运行。 压缩对齐可以减少应用程序消耗的 RAM。
重要
建议将以下每个密码存储在机密变量中。
- task: AndroidSigning@2
inputs:
apkFiles: '**/*.apk'
jarsign: true
jarsignerKeystoreFile: 'pathToYourKeystoreFile'
jarsignerKeystorePassword: '$(jarsignerKeystorePassword)'
jarsignerKeystoreAlias: 'yourKeystoreAlias'
jarsignerKeyPassword: '$(jarsignerKeyPassword)'
zipalign: true
测试
在 Android Emulator 中进行测试
创建 Bash 任务,然后复制并粘贴以下代码以安装并运行该模拟器。 请记得根据你的测试环境排列模拟器参数。 该模拟器作为后台进程启动,可在后续任务中使用。
#!/usr/bin/env bash
# Install AVD files
echo "y" | $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --install 'system-images;android-27;google_apis;x86'
# Create emulator
echo "no" | $ANDROID_HOME/tools/bin/avdmanager create avd -n xamarin_android_emulator -k 'system-images;android-27;google_apis;x86' --force
$ANDROID_HOME/emulator/emulator -list-avds
echo "Starting emulator"
# Start emulator in background
nohup $ANDROID_HOME/emulator/emulator -avd xamarin_android_emulator -no-snapshot > /dev/null 2>&1 &
$ANDROID_HOME/platform-tools/adb wait-for-device shell 'while [[ -z $(getprop sys.boot_completed | tr -d '\r') ]]; do sleep 1; done; input keyevent 82'
$ANDROID_HOME/platform-tools/adb devices
echo "Emulator started"
在 Azure 托管的设备上进行测试
添加 App Center 测试任务,以在 iOS 和 Android 设备的托管实验室中测试应用程序。 需要一个 App Center 免费试用帐户,以后必须将其转换为付费帐户。
# App Center test v1
# Test app packages with Visual Studio App Center.
- task: AppCenterTest@1
inputs:
appFile: # string. Alias: app. Required. Binary application file path.
artifactsDirectory: '$(Build.ArtifactStagingDirectory)/AppCenterTest' # string. Alias: artifactsDir. Required. Artifacts directory. Default: $(Build.ArtifactStagingDirectory)/AppCenterTest.
# Prepare Tests
#prepareTests: true # boolean. Alias: enablePrepare. Prepare tests. Default: true.
frameworkOption: 'appium' # 'appium' | 'espresso' | 'calabash' | 'uitest' | 'xcuitest'. Alias: framework. Required when enablePrepare = true. Test framework. Default: appium.
#appiumBuildDirectory: # string. Alias: appiumBuildDir. Required when enablePrepare = true && framework = appium. Build directory.
#espressoBuildDirectory: # string. Alias: espressoBuildDir. Optional. Use when enablePrepare = true && framework = espresso. Build directory.
#espressoTestApkFile: # string. Alias: espressoTestApkPath. Optional. Use when enablePrepare = true && framework = espresso. Test APK path.
#calabashProjectDirectory: # string. Alias: calabashProjectDir. Required when enablePrepare = true && framework = calabash. Project directory.
#calabashConfigFile: # string. Optional. Use when enablePrepare = true && framework = calabash. Cucumber config file.
#calabashProfile: # string. Optional. Use when enablePrepare = true && framework = calabash. Profile to run.
#calabashSkipConfigCheck: false # boolean. Optional. Use when enablePrepare = true && framework = calabash. Skip Configuration Check. Default: false.
#uiTestBuildDirectory: # string. Alias: uitestBuildDir. Required when enablePrepare = true && framework = uitest. Build directory.
#uitestStorePath: # string. Optional. Use when enablePrepare = true && framework = uitest. Store file.
#uiTestStorePassword: # string. Alias: uitestStorePass. Optional. Use when enablePrepare = true && framework = uitest. Store password.
#uitestKeyAlias: # string. Optional. Use when enablePrepare = true && framework = uitest. Key alias.
#uiTestKeyPassword: # string. Alias: uitestKeyPass. Optional. Use when enablePrepare = true && framework = uitest. Key password.
#uiTestToolsDirectory: # string. Alias: uitestToolsDir. Optional. Use when enablePrepare = true && framework = uitest. Test tools directory.
#signInfo: # string. Optional. Use when framework = calabash || framework = uitest. Signing information.
#xcUITestBuildDirectory: # string. Alias: xcuitestBuildDir. Optional. Use when enablePrepare = true && framework = xcuitest. Build directory.
#xcUITestIpaFile: # string. Alias: xcuitestTestIpaPath. Optional. Use when enablePrepare = true && framework = xcuitest. Test IPA path.
#prepareOptions: # string. Alias: prepareOpts. Optional. Use when enablePrepare = true. Additional options.
# Run Tests
#runTests: true # boolean. Alias: enableRun. Run tests. Default: true.
credentialsOption: 'serviceEndpoint' # 'serviceEndpoint' | 'inputs'. Alias: credsType. Required when enableRun = true. Authentication method. Default: serviceEndpoint.
#serverEndpoint: # string. Required when enableRun = true && credsType = serviceEndpoint. App Center service connection.
#username: # string. Required when enableRun = true && credsType = inputs. App Center username.
#password: # string. Required when enableRun = true && credsType = inputs. App Center password.
appSlug: # string. Required when enableRun = true. App slug.
devices: # string. Required when enableRun = true. Devices.
#series: 'master' # string. Optional. Use when enableRun = true. Test series. Default: master.
#dsymDirectory: # string. Alias: dsymDir. Optional. Use when enableRun = true. dSYM directory.
localeOption: 'en_US' # 'da_DK' | 'nl_NL' | 'en_GB' | 'en_US' | 'fr_FR' | 'de_DE' | 'ja_JP' | 'ru_RU' | 'es_MX' | 'es_ES' | 'user'. Alias: locale. Required when enableRun = true. System language. Default: en_US.
#userDefinedLocale: # string. Optional. Use when enableRun = true && locale = user. Other locale.
#loginOptions: # string. Alias: loginOpts. Optional. Use when enableRun = true && credsType = inputs. Additional options for login.
#runOptions: # string. Alias: runOpts. Optional. Use when enableRun = true. Additional options for run.
#skipWaitingForResults: false # boolean. Alias: async. Optional. Use when enableRun = true. Do not wait for test result. Default: false.
# Advanced
#cliFile: # string. Alias: cliLocationOverride. App Center CLI location.
#showDebugOutput: false # boolean. Alias: debug. Enable debug output. Default: false.
将工件与生成记录一起保留
添加复制文件和发布生成工件任务。 APK 将随生成记录或测试一起存储,并会在后面的管道中部署。 有关详细信息,请参阅工件。
- task: CopyFiles@2
inputs:
contents: '**/*.apk'
targetFolder: '$(build.artifactStagingDirectory)'
- task: PublishBuildArtifacts@1
部署
添加 App Center
添加 App Center 分发任务,以将应用程序分发给一组测试人员或 beta 版用户,或将应用程序升级到 Intune 或 Google Play。 需要一个 App Center 免费帐户(无需付款)。
# App Center distribute v3
# Distribute app builds to testers and users via Visual Studio App Center.
- task: AppCenterDistribute@3
inputs:
serverEndpoint: # string. Required. App Center service connection.
appSlug: # string. Required. App slug.
appFile: # string. Alias: app. Required. Binary file path.
#buildVersion: # string. Build version.
releaseNotesOption: 'input' # 'input' | 'file'. Alias: releaseNotesSelection. Required. Create release notes. Default: input.
releaseNotesInput: # string. Required when releaseNotesSelection = input. Release notes.
#releaseNotesFile: # string. Required when releaseNotesSelection = file. Release notes file.
#isMandatory: false # boolean. Require users to update to this release. Default: false.
destinationType: 'groups' # 'groups' | 'store'. Required. Release destination. Default: groups.
#distributionGroupId: # string. Alias: destinationGroupIds. Optional. Use when destinationType = groups. Destination IDs.
#destinationStoreId: # string. Required when destinationType = store. Destination ID.
#isSilent: # boolean. Optional. Use when destinationType = groups. Do not notify testers. Release will still be available to install.
# Symbols
#symbolsOption: 'Apple' # 'Apple' | 'Android' | 'UWP'. Alias: symbolsType. Symbols type. Default: Apple.
#symbolsPath: # string. Optional. Use when symbolsType == AndroidNative || symbolsType = Windows. Symbols path.
#appxsymPath: # string. Optional. Use when symbolsType = UWP. Symbols path (*.appxsym).
#symbolsDsymFiles: # string. Alias: dsymPath. Optional. Use when symbolsType = Apple. dSYM path.
#symbolsMappingTxtFile: # string. Alias: mappingTxtPath. Optional. Use when symbolsType = Android. Mapping file.
#nativeLibrariesPath: # string. Optional. Use when symbolsType == Android. Native Library File Path.
#symbolsIncludeParentDirectory: # boolean. Alias: packParentFolder. Optional. Use when symbolsType = Apple. Include all items in parent folder.
安装 Google Play
安装 Google Play 扩展,并使用以下任务来自动与 Google Play 交互。 默认情况下,这些任务会使用你配置的服务连接向 Google Play 进行身份验证。
发布
添加 Google Play 发布任务,以将新的 Android 应用版本发布到 Google Play 商店。
- task: GooglePlayRelease@4
inputs:
apkFile: '**/*.apk'
serviceEndpoint: 'yourGooglePlayServiceConnectionName'
track: 'internal'
升级
添加 Google Play 升级任务,以将先前发布的 Android 应用程序更新从一个跟踪版升级到另一个跟踪版,例如 alpha
→ beta
。
- task: GooglePlayPromote@3
inputs:
packageName: 'com.yourCompany.appPackageName'
serviceEndpoint: 'yourGooglePlayServiceConnectionName'
sourceTrack: 'internal'
destinationTrack: 'alpha'
增大推出范围
添加 Google Play 增大推出范围任务,以增大先前发布到 rollout
跟踪版的应用程序的推出百分比。
- task: GooglePlayIncreaseRollout@2
inputs:
packageName: 'com.yourCompany.appPackageName'
serviceEndpoint: 'yourGooglePlayServiceConnectionName'
userFraction: '0.5' # 0.0 to 1.0 (0% to 100%)
状态更新
添加 Google Play 状态更新任务,以更新先前发布到 rollout
跟踪版的应用程序的推出状态。
- task: GooglePlayStatusUpdate@2
inputs:
authType: ServiceEndpoint
packageName: 'com.yourCompany.appPackageName'
serviceEndpoint: 'yourGooglePlayServiceConnectionName'
status: 'inProgress' # draft | inProgress | halted | completed
相关扩展
- Codified Security (Codified Security)
- Google Play (Microsoft)
- 适用于 iOS 和 Android 的移动应用任务 (James Montemagno)
- 移动测试实验室 (Perfecto Mobile)
- React Native (Microsoft)
常见问题解答
问:如何创建应用捆绑包?
答:可以使用内联脚本和安全文件生成应用捆绑包并为其签名。 为此,请先下载密钥存储,并将其作为安全文件存储在库中。 然后,在变量组中为 keystore.password
、key.alias
和 key.password
创建变量。
接下来,使用下载安全文件和 Bash 任务下载密钥存储,生成应用捆绑包并为其签名。
在此 YAML 文件中,下载一个 app.keystore
安全文件并使用 bash 脚本生成应用捆绑包。 然后,使用复制文件复制该应用捆绑包。 接着,使用发布生成工件创建并保存一个工件,或使用 Google Play 扩展进行发布。
- task: DownloadSecureFile@1
name: keyStore
displayName: "Download keystore from secure files"
inputs:
secureFile: app.keystore
- task: Bash@3
displayName: "Build and sign App Bundle"
inputs:
targetType: "inline"
script: |
msbuild -restore $(Build.SourcesDirectory)/myAndroidApp/*.csproj -t:SignAndroidPackage -p:AndroidPackageFormat=aab -p:Configuration=$(buildConfiguration) -p:AndroidKeyStore=True -p:AndroidSigningKeyStore=$(keyStore.secureFilePath) -p:AndroidSigningStorePass=$(keystore.password) -p:AndroidSigningKeyAlias=$(key.alias) -p:AndroidSigningKeyPass=$(key.password)
- task: CopyFiles@2
displayName: 'Copy deliverables'
inputs:
SourceFolder: '$(Build.SourcesDirectory)/myAndroidApp/bin/$(buildConfiguration)'
Contents: '*.aab'
TargetFolder: 'drop'