Androidプロジェクトを使い始める

このガイドでは、AndroidアプリをBitriseに追加する方法、デフォルトのWorkflowsでできること、そして最後にアプリをbitrise.ioとGoogle Play Storeにテストおよびデプロイする方法について説明します。

Bitrise アカウントをお持ちですか？

bitrise.io にサインアップ済みで、Bitrise アカウントにアクセスできることを確認してください。アカウントを登録する方法は複数あります。

• メールでのサインアップ
• Git プロバイダーでのサインアップ

BitriseにAndroidプロジェクトを追加する

プロジェクトの追加方法は他の場合と同じです。ウィザードの完全な手順については、Adding a new projectをご覧ください。このセクションでは、Androidに固有の内容について説明します。

スキャナーがAndroidプロジェクトを検出する仕組み

プロジェクトスキャナーは、リポジトリ内でGradleのラッパースクリプト（gradlew）を探し、その隣にあるGradleのビルドスクリプトでcom.android.applicationプラグインを確認します。このプラグインがbuild.gradleまたはbuild.gradle.ktsファイルの少なくとも1つで見つかった場合、プロジェクトはAndroidとして登録されます。

スキャナーは、.git、.gradle、.idea、build、node_modulesなどの一般的な非ソースディレクトリをスキップします。また、リポジトリがすでにFlutter、React Native、Cordova、Ionic、またはKotlin Multiplatformとして検出されている場合も処理を行いません。これらのスキャナーは、それぞれのAndroid設定を独自に処理するためです。

設定できる項目

CI configurationの段階では、ウィザードに以下が表示されます。

• Project location: gradlewファイルが含まれるディレクトリです。スキャナーが複数見つけた場合は、使用するものを選択できます。
• Module: ビルド対象のGradleモジュールです（例: app）。
• Variant: 使用するビルドバリアントです（例: Debug）。空欄のままにして、後からバリアントを追加することもできます。

Androidプロジェクトの依存関係を管理する

Gradleビルドシステムでは、外部のバイナリやその他のライブラリモジュールを依存関係として含めることができます。Bitriseは、ビルドプロセス中にプロジェクトのこれらの依存関係をインストールできます。

ビルド依存関係の追加

Androidプロジェクトへの依存関係の追加については、こちらをご覧ください: https://developer.android.com/studio/build/dependencies

1. プロジェクトのbuild.gradleファイルにすべての依存関係が記載されていることを確認してください。

2. Bitrise にアクセスして Log in、左側の Bitrise CI を選択し、プロジェクトを選択します。

3. メインページの Workflows ボタンをクリックします。

4. WorkflowにAndroid BuildのStepが含まれていることを確認してください。

   アプリを初めて追加したときにプロジェクトスキャナーがbuild_apkというWorkflowを生成した場合、そのWorkflowにはStepが含まれています。追加の設定なしに、build.gradleファイルに記載されているすべての依存関係をインストールします。

5. WorkflowにInstall missing Android SDK components Stepが含まれていることを確認してください。

   Stepは、Workflow内でAndroid Build Stepより前に配置する必要があります。これにより、プロジェクトに必要なAndroid SDKツールがすべてインストールされます。

Androidアプリをテストする

CIプロセス中にAndroidアプリのテストを支援する、専用のStepsを複数用意しています。

• Android Lint Stepは、Androidのproject sourceファイルに対してLintを実行し、コードにエラーがないように潜在的な構文エラーを検出します。
• Android Unit Test Stepは、プロジェクトのユニットテストを実行します。さまざまなモジュールやフレーバーすべてに対して実行できます。Androidユニットテスト
• Virtual Device Testing for Androidは、Firebase TestLabを使用して仮想デバイス上でAndroidテストを実行します。Androidのデバイステスト

Android Unit Test StepとVirtual Device Testing for Android Stepは、どちらも結果をテストレポートにエクスポートできます。そのためには、Workflowの一番最後にWorkflowのDeploy to Bitrise.io Stepが含まれていることを確認するだけです。

Androidアプリに署名する

AndroidアプリをGoogle Playに公開するには、アプリにデジタル署名する必要があります。Bitriseでもこれを行うことができます。keystoreファイルをアップロードし、必要な認証情報を入力するだけです。

その他のcode signingオプション

このセクションでは、Android Sign Stepを使用してAndroidアプリに署名する方法について説明します。アプリに署名する方法は他にもあります。関連ガイドの他のオプションをご確認ください: Android code signing。

1. keystoreファイルの生成keystoreファイルの生成。

   1. プロジェクトに対するAdminのロールを持つユーザー、またはEdit workflow権限を持つカスタムロールを持つユーザーで、Bitrise上のプロジェクトを開きます。
   2. プロジェクトのメインページで、Project settingsボタンをクリックします。

2. 左側のメニューからCode signingを選択します。

3. keystoreファイルをANDROID KEYSTORE FILEフィールドにドラッグ＆ドロップします。

4. Keystore password、Keystore alias、Private key passwordの各フィールドに入力し、Save metadataをクリックします。

   

5. Workflow Editorを開きます。

6. WorkflowにAndroid Sign Stepを追加します。

以上です。次回ビルドを実行すると、Android Sign Stepが生成されたバイナリに署名します。

Androidアプリを bitrise.io にデプロイする

このセクションでは、Android プロジェクトを bitrise.io にデプロイする方法を説明します。

bitrise.io にデプロイすると、ビルド中に生成されたビルドアーティファクトを、ビルドの完了後にダウンロードできるようになります。たとえば、これを利用して、Androidアプリを自分のテストデバイスでテストできます。

アプリを bitrise.io にデプロイするには、次の手順を実行します。

Workflow Editor

1. Workflowに、アプリをビルドするための Android Build Stepが含まれていることを確認します。

   必要に応じて、Gradle Runner Stepでアプリをビルドすることもできます。この場合は追加の設定が少し必要になりますが、より幅広いカスタマイズが可能です。

2. Deploy to Bitrise.io Stepを Workflowに追加します。

   他のユーザーへの通知

   Stepの Notify: User Roles 入力と Notify: Emails 入力を使用して、デプロイに関する通知を設定できます。入力名をクリックすると、設定方法の詳細が表示されます。

3. 必要に応じて、Stepの Enable public page for the App? 入力を true に設定すると、Stepがアプリの公開インストールページを有効化します。

4. ビルドを実行します。

Configuration YAML

1. アプリの bitrise.yml ファイルを開きます。

2. Workflowに、アプリをビルドするための android-build Stepが含まれていることを確認します。

   workflows:
     example-workflow:
       steps:
       - android-build@1:

   必要に応じて、gradle-runner Stepでアプリをビルドすることもできます。この場合は追加の設定が少し必要になりますが、より幅広いカスタマイズが可能です。

3. module 入力や variant 入力を設定して、Stepに何をビルドするかを指定します。

   この例では、Androidプロジェクトのデバッグバリアントをビルドしています。

   workflows:
     example-workflow:
       steps:
       - android-build@1:
           inputs:
           - variant: debug
       - deploy-to-bitrise-io: {}

4. deploy-to-bitrise-io Stepを Workflowに追加します。

   workflows:
     example-workflow:
       steps:
       - android-build@1:
           inputs:
           - variant: debug
       - deploy-to-bitrise-io: {}

   他のユーザーへの通知

   Stepの notify_user_groups 入力と notify_email_list 入力を使用して、デプロイに関する通知を設定できます。

   • notify_user_groups 入力では、ユーザーに付与されたアクセスロールに基づいて通知を送信できます。たとえば、Admin ロールと Developer ロールを持つすべてのユーザーに通知するよう設定できます。複数のロールを指定する場合は、カンマで区切ります: - notify_user_groups: admins, testers
   • notify_email_list 入力は Secretsのみを受け付けます。また、Secret にはメールアドレスをカンマ区切りで指定する必要があります。

5. 必要に応じて、Stepの Enable public page for the App? 入力を true に設定すると、Stepがアプリの公開インストールページを有効化します。

6. ビルドを実行します。

Deploy to Bitrise.io Stepがアプリをデプロイします。生成されたバイナリは、ビルドの URL を使用してチームメンバーと共有できます。

bitrise.yml: Androidアプリを Bitrise にデプロイする

この例では、Androidアプリの debug バリアントをビルドし、bitrise.io にデプロイします。

Google Playデプロイを初めて設定する

Google playへのデプロイは、アプリをGoogleのオンラインストアに公開します。初めて行う場合は、bitrise.ioへのデプロイよりも少し多くの作業が必要です。必要な設定が完了すれば、その後は非常に簡単になります。

Google Playへのデプロイを初めて設定するときは、Google Play DeveloperアカウントをAPIプロジェクトにリンクし、APIアクセスを設定して、サービスアカウントのJSONキーをBitriseにアップロードする必要があります。

1. 最初のAABまたはAPKを、Google Play Consoleを使用してGoogle Playに手動でアップロードします。

2. Google Play Developer ConsoleをAPIプロジェクトにリンクします。

3. サービスアカウントを使用してAPI Access Clientsを設定します。Google Developer Consoleでサービスアカウントを作成するときは、Key Typeとしてjsonを選択する必要があります。

4. Google Play Consoleで、サービスアカウントに必要な権限を付与します。Settings、Users & permissions、Invite new userの順に移動してください。Google Play Publisher APIの仕組み上、サービスアカウントには少なくとも次の権限を付与する必要があります。

   • Access level: View app information.
   • Release management: Manage production releases, manage testing track releases.
   • Store presence: Edit store listing, pricing & distribution.

5. 任意の手順として、ストアの掲載情報に翻訳を追加できます。アプリを翻訳してローカライズするを参照してください。

6. GoogleサービスアカウントをBitriseに接続します。

Google Playへのデプロイ

Google Playにデプロイするには、署名済みの APK または AAB ファイルと、Google Play Deploy Stepが必要です。

Workflow Editor

1. サービスアカウントの JSON キーを Files セクションにアップロードしてください。

2. Files セクションで、サービスアカウントファイルの Download URL をコピーしてください。

   例: BITRISEIO_SERVICE_ACCOUNT_JSON_KEY_URL

3. Workflow Editor を開き、Secrets を選択してください。

4. コピーしたダウンロード URL を値として、Secret を作成してください。

   JSON キーファイルを Bitrise にアップロードした場合、ダウンロード URL は環境変数であるため、Replace variables in inputs チェックボックスをオンにしてください。

   Direct link

   キーストアファイルを Bitrise にアップロードせず、ダイレクトリンクを使用する場合は、Replace the variables in inputs オプションをオンにする必要はありません。

5. Google Play Deploy Stepを Workflow に追加してください。

6. Service Account JSON key file path 入力に、作成した Secret を貼り付けてください。

7. Package name 入力に、アプリの package name を入力してください。

8. Track 入力に、APK のデプロイ先のトラックを入力してください(例: alpha/beta/rollout/production、または設定したカスタムトラック)。

Configuration YAML

1. サービスアカウントの JSON キーを Files セクションにアップロードしてください。

   Uploading the service account JSON key file

   サービスアカウントの JSON キーは Bitrise にアップロードすることを推奨しますが、必須ではありません。別の場所に保存し、そのダイレクトリンクを指定することもできます。

2. アプリの Configuration YAML ファイルを開き、google-play-deploy Stepを追加してください。

   deploy-workflow:
     steps: 
     - google-play-deploy: 
         inputs:

3. service_account_json_key_path 入力に、サービスアカウントの JSON キーファイルのパスを指定する必要があります。

   そのパスのSecret を作成し、ここで参照してください。

   deploy-workflow:
     steps: 
     - google-play-deploy: 
         inputs:   
         - service_account_json_key_path: "$BITRISEIO_SERVICE_ACCOUNT_JSON_KEY_URL"

4. package 入力に、アプリのpackage nameを入力してください。

   deploy-workflow:
     steps: 
     - google-play-deploy: 
         inputs:   
         - service_account_json_key_path: "$BITRISEIO_SERVICE_ACCOUNT_JSON_KEY_URL"
         - package_name: myApp

5. track 入力に、アプリバイナリのデプロイ先のトラックを入力してください(例: alpha/beta/rollout/production、または設定したカスタムトラック)。

   deploy-workflow:
     steps: 
     - google-play-deploy: 
         inputs:   
         - service_account_json_key_path: "$BITRISEIO_SERVICE_ACCOUNT_JSON_KEY_URL"
         - package_name: myApp
         - track: alpha

以上で完了です。ビルドを開始またはスケジュールし、URLを外部のテスターと共有するか、任意のアプリストアでアプリを配布してください。