Android アプリのビルド、テスト、デプロイ

Azure DevOps Services

Android アプリケーションを自動的にビルド、テスト、およびデプロイするためのパイプラインを設定できます。

前提条件

次の項目が必要です。

パイプラインのセットアップ

サンプルの Android アプリケーションのパイプラインを設定するには、次のタスクを実行します。

  1. 次のリポジトリを GitHub アカウントにフォークして、簡単な Android アプリケーションのコードを取得します。

    https://github.com/MicrosoftDocs/pipelines-android
    
  2. Azure DevOps 組織にサインインし、プロジェクトに移動します。

  3. [パイプライン]>[Create pipeline] (パイプラインの作成) または [新しいパイプライン] の順に選択します。

  4. ソース コードの場所として [GitHub] を選択します。

    Screenshot showing list of repositories to select from.

    サインインするために GitHub にリダイレクトされる場合があります。 その場合は、GitHub の資格情報を入力します。

  5. 前にフォークした -android リポジトリを選択します。

  6. 次の画面で [Approve and install] (承認してインストール) を選択します。

    Azure Pipelines はパイプラインの YAML ファイルを生成します。

  7. [実行] を選択します。

  8. メイン ブランチに直接コミットし、もう一度 [実行] を選択します。

  9. 実行が終了するまで待ちます。

リポジトリで 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 の値を調整します (assembleDebugassembleRelease など)。 詳細については、次に示す Google Android 開発ドキュメントを参照してください。

Android パッケージ (APK) に署名および配置する

まだビルドで APK の署名と zipalign が行われていない場合は、YAML に Android 署名タスクを追加します。 エミュレーターではなくデバイスで実行するには、APK に署名する必要があります。 Zipaligning は、アプリケーションが消費する 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 にサインアップします。

# 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 の配布タスクを追加して、テスト担当者やベータ ユーザーのグループにアプリケーションを配布するか、アプリケーションを 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'

昇格

以前にリリースした Android アプリケーションの更新を、あるトラックから別のトラックに昇格させる (alphabeta など) には、Google Play の昇格タスクを追加します。

- 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

よく寄せられる質問

Q: アプリ バンドルを作成するにはどうすればよいですか。

A: アプリ バンドルは、インライン スクリプトとセキュリティで保護されたファイルを使用して、ビルドおよび署名できます。 これを行うには、まずキーストアをダウンロードし、セキュリティで保護されたファイルとしてライブラリに格納します。 その後、変数グループkeystore.passwordkey.aliaskey.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'