メインコンテンツまでスキップ

Ionic/Cordovaプロジェクトを使い始める

CordovaとIonicのフレームワークを使用すると、クロスプラットフォームアプリを開発できます。Bitriseは自動テスト、code signing、デプロイの手順をサポートしているため、iOSアプリやAndroidアプリをすぐに各マーケットプレイスにリリースできます。Workspaceの同時実行数が1を超える場合は、AndroidビルドとiOSビルドを同時に実行できます。それでは、その手順をご案内します。

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

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

BitriseにIonic/Cordovaプロジェクトを追加するClick to copy link​

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

スキャナーがIonicとCordovaを区別する方法Click to copy link​

プロジェクトスキャナーは、まずionic.config.jsonファイル、またはレガシーのionic.projectファイルを確認します。いずれかが見つかった場合、プロジェクトをIonicとして登録し、config.xmlはまったく確認しません。

Ionicファイルがどちらも存在しない場合、スキャナーはcordova.apache.org名前空間を持つconfig.xmlファイルを探し、プロジェクトをCordovaとして登録します。そのconfig.xmlと一緒にIonicの設定ファイルも見つかった場合は、代わりにIonicを優先します。

設定できる項目Click to copy link​

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

  • Directory of the config.xml file: 設定ファイルがリポジトリのルートにない場合にのみ表示されます。
  • Platform: ビルド対象のプラットフォーム(Android、iOS、または両方)を指定します。

JavaScriptの依存関係のインストールClick to copy link​

Bitriseの プロジェクトスキャナーがプロジェクトのスキャンに成功すると、Run npm command または Run yarn command Stepsがデフォルトの Workflows に含まれます。これらのStepsは、アプリに不足しているJavaScriptの依存関係をインストールできます。

ネイティブのAndroidの依存関係には、Install missing Android SDK components Stepを使用できます。

ネイティブの iOS の依存関係には、Brew install Stepや Run CocoaPods install Stepなどを使用できます。

npm でJavaScriptの依存関係をインストールするには、次の手順を実行します。

npm の代わりに Yarn を使用する

このガイドでは、JavaScriptの依存関係のインストールに npm を使用しています。ただし、Run yarn command Stepを使用することもできます。追加の設定なしで、不足している JS の依存関係をインストールできます。

  1. Log inでBitriseに移動し、左側で Bitrise CI を選択して、プロジェクトを選択してください。

  2. メインページで Workflows ボタンをクリックしてください。

  3. Workflowに Run npm command Stepが含まれていることを確認してください。

  4. The 'npm' command with arguments to run 入力変数に install と入力してください。

    Getting_started_with_React_Native_apps.png

    npm installの代わりにnpm ciコマンドを使用する

    プロジェクトに最新の package-lock.json ファイルがある場合は、The 'npm' command with arguments to run 入力で ci コマンドを使用することを推奨します。npm ciを使用すると、npm installに比べてビルド時間が大幅に短縮されるだけでなく、ビルドの信頼性も向上します。

Ionic/CordovaアプリのテストClick to copy link​

Bitrise上でKarma Jasmine Test RunnerまたはJasmine Test RunnerのStepsを使用して、Ionic/Cordovaアプリのユニットテストを実行できます。

Cordova/Ionicプロジェクトのpackage.json ファイルにKarma Jasmineの依存関係があり、かつプロジェクトルートにkarma.conf.jsファイルがある場合、アプリを追加する際にスキャナーがこれを検出し、該当するテストStepをWorkflowに自動的に挿入します。この依存関係がプロジェクトにない場合は、Workflow Editorを使用して、テストStepのいずれかをWorkflowに手動で挿入できます。

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

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

  3. Workflowにテスト用のStepがあることを確認してください。

    依存関係のインストール

    テストを実行する前に、JavaScriptの依存関係のインストールを完了していることを確認してください。

    Karma Jasmine Test RunnerとJasmine Test RunnerのStepsのいずれかを選択できます。

Karma Jasmine Test Runnerを使用したCordovaアプリの設定

この例では、primaryというWorkflowを含むbitrise.ymlの設定を確認できます。このWorkflowにはKarma Jasmine Test RunnerStepが含まれています。

primary:
steps:
run_if: '{{getenv "SSH_RSA_PRIVATE_KEY" | ne ""}}'
title: Do anything with Script step
inputs:
- command: install

Code signing Ionic/CordovaプロジェクトClick to copy link​

iOSまたはAndroid向けにアプリをビルドする場合は、Project settingsページでプラットフォーム固有のファイルをアップロードする必要があります。両方のプラットフォーム向けにビルドを生成することもできますが、その場合は各プラットフォームのcode signingファイルをすべてアップロードする必要があります。

IonicおよびCordovaプロジェクト向けのiOS code signingClick to copy link​

当然ながら、BitriseはIonicまたはCordovaのいずれかで構築されたiOSアプリケーションをサポートしています。ただし、code signingのプロセスはネイティブのXcodeプロジェクトと比べて若干異なります。

BitriseはIonicおよびCordovaアプリについても手動および自動のプロビジョニングをサポートしていますが、この場合もプロセスはやや異なります。

手動でのcode signingアセット管理を使用したIonic/Cordova code signingClick to copy link​

  1. cordova platform add iosまたはionic cordova platform add iosを呼び出して、IonicまたはCordovaプロジェクトからローカルでネイティブのXcodeプロジェクトを生成します。

  2. ファイルをbitrise.ioにアップロードします。Project settingsページを開き、左側でCode signingを選択します。証明書とプロビジョニングプロファイルをアップロードします。

    upload-code-signing.png

  3. WorkflowにCertificate and profile installerStepがあることを確認してください。

  4. Generate cordova build configurationStepをWorkflowに追加します。これはCertificate and profile installerStepの後に配置する必要があります。

  5. Stepに必要な入力項目を入力します。Code Signing IdentityとProvisioning Profileは、そのように明記されていなくても、iOSアプリには必須の入力項目である点に注意してください。

    • Build configuration: debugまたはreleaseのいずれかに設定できます。

    • Code Sign Identity: DeveloperまたはDistributionのIDを入力します。

    • Provisioning Profile: 適切なプロビジョニングプロファイルを入力します。

    • Packaging Type: Xcodeによって生成されるビルドの種類を制御します。必要なcode signingの種類を設定してください。

      gen-cordova-build.png

  6. Cordova archiveまたはIonic archiveStepをWorkflowに追加します。

  7. 必要な入力項目を入力します。

    • Platformの入力はdeviceに設定する必要があります。
    • Build command configurationの入力は、Generate cordova build configurationStepのBuild configuration入力と一致させる必要があります。

    このStepは、Workflow内のGenerate cordova build configurationStepの後に配置する必要があります。

  8. ビルドを実行しましょう。

automatic code signingアセット管理を使用したIonic/Cordova code signingClick to copy link​

  1. .p12のsigning certificateがbitrise.ioにアップロードされていることを確認してください。

  2. Cordova prepareまたはIonic prepareStepをWorkflowに追加します。これらのStepsはplatform rmおよびplatform addコマンドを呼び出します。

  3. Manage iOS Code SigningStepをWorkflowに追加します。WorkflowにCertificate and Profile InstallerとManage iOS Code SigningStepsの両方がある場合、ビルドで予期しない問題が発生する可能性があります。

    Stepは以下をエクスポートします。

    • プロジェクトのDevelopment Team。
    • インストールされているcodesign identityの名前。
    • インストールされているプロビジョニングプロファイル。
    code signing Stepは1つのみ

    WorkflowにCertificate and profile installerとManage iOS Code SigningStepsの両方がある場合、ビルドで予期しない問題が発生する可能性があります。

  4. (Bitriseで設定したAppleサービスに基づく)Apple service connection methodとDistribution methodを選択します。

    manage-ios-code.png

  5. Generate cordova build configurationStepをWorkflowに追加します。

  6. Manage iOS Code SigningStepによってエクスポートされたcode signing設定を使用するようにStepを設定します。

    開発配布の例:

    - generate-cordova-build-configuration:
    inputs:
    - development_team: $BITRISE_DEVELOPER_TEAM
    - package_type: development
    - code_sign_identity: iPhone Developer
    - configuration: debug

    本番配布の例:

    - generate-cordova-build-configuration:
    inputs:
    - development_team: $BITRISE_DEVELOPER_TEAM
    - package_type: app-store
    - code_sign_identity: iPhone Developer
    - configuration: release
  7. Cordova ArchiveまたはIonic ArchiveStepをWorkflowに追加します。

  8. 必要な入力項目を入力します。

    • Platformの入力はdeviceに設定する必要があります。

    • Build command configurationの入力は、Generate cordova build configurationStepのBuild configuration入力と一致させる必要があります。

      gen-cordova-build.png

  9. Should remove platforms as prepare step?をfalseに設定します。これは重要です。Cordova prepareまたはIonic prepareStepで生成されたネイティブプロジェクトのプラットフォームを、Stepが削除して再追加しないようにするためです。

  10. ビルドを実行しましょう。

Android Sign Stepを使用したAndroid code signingClick to copy link​

Bitrise Workflow内のAndroid SignStepを使用して、署名済みAPKを作成できます。このStepは、キーストアファイルをすでにBitriseにアップロードしている場合に実行されるよう設定されています。

プロジェクトのbuild.gradleファイルで署名が設定されている場合、Android SignStepは不要です。その場合、Android BuildStep(またはGradle RunnerStep)を実行すると、出力(APKまたはAAB)が自動的に署名されます。とはいえ、簡単かつ安全にプロジェクトに署名するために、Android SignStepの使用をお勧めします。

jarsignとapksigner

APKはjarsignerまたはapksignerのいずれかで署名できます。APKでapksignerを使用してプロジェクトに署名する場合は、まずAndroid Sign StepのEnables apksigner入力をtrueに設定し、APK Signature Scheme入力はautomaticのままにしておく必要があります。こうすることで、apksignerがAPKの最小および対象のSDKバージョンを確認し、必要なスキームを選択します。最小サポートバージョンが低い場合はV1スキームで署名し、より新しいシステム向けには他のスキームでも署名します。

AABファイルはjarsignerでのみ署名できる点に注意してください。Stepは、.aabで終わるファイルを検出した場合にjarsignerを使用します。

  1. キーストアファイルをBitriseにアップロードする。

  2. APKまたはAABファイルをビルドするStepの後に、Android SignStepをWorkflowに追加します。

    Bitriseは上記のEnvironment Variablesを使用し、それらをAndroid SignStepの各フィールドの入力として設定します。Stepが実行されると、署名済みのAPKまたはAABが生成されます。署名済みのAPKまたはAABは、例えばGoogle Play DeployStepやDeploy to Bitrise.ioStepといったデプロイStepsで使用されます。後者は、APK/AABをArtifactsタブにデプロイします。インストール可能なアーティファクトをビルドした後は、Release Managementを使用してアプリをデプロイすることもできます。

キーストアファイルのダウンロード

File DownloaderStepを使用して、キーストアファイルをプロジェクトディレクトリにダウンロードできます。

- file-downloader:
inputs:
- source: $BITRISEIO_ANDROID_KEYSTORE_URL
- destination: "$HOME/keystores/my_keystore.jks" #native android#

Stepでキーストアファイルが必要な場合は、そのStepをFile DownloaderStepの後に必ず配置してください。

このStepの後、my_keystore.jksが$HOME/keystores/my_keystore.jksで利用可能になります。

Ionic/CordovaアプリのデプロイClick to copy link​

BitriseでIonicまたはCordovaアプリをビルドしてデプロイするには、(両方をビルドする場合は)AndroidとiOSの両方のプロジェクトにデジタル署名し、その後Cordova ArchiveまたはIonic Archive Stepを使用してデプロイ前にアプリをビルドする必要があります。

正常にビルドされたアプリは、以下にデプロイできます。

  • Google Play StoreやAppleのApp Storeなどのオンラインストア。
  • Bitrise.io: 生成されたバイナリは、ビルドページのArtifactsタブで利用できます。そこからダウンロードしたり、パブリックインストールページ経由で他のユーザーと共有したりできます。

クロスプラットフォームアプリをbitrise.ioにデプロイするClick to copy link​

Deploy to bitrise.ioStepは、ビルドに関連するすべてのアーティファクトを、BuildのページのArtifactsタブにアップロードします。

生成されたバイナリファイル(Androidの場合はAPK、iOSの場合はIPAファイル)は、パブリックインストールページを使用してチームメンバーと共有できます。パブリックインストールページはURLであり、他のユーザーと共有することで、生成されたアプリバイナリをそれぞれのデバイスにインストールしてもらえます。また、APKまたはIPAファイルがビルドされたことを、ユーザーグループや個々のユーザーに通知することもできます。

expo.ioへの公開

Deploy to Bitrise.ioStepはExpoコマンドを使用せず、expo.ioへの公開も行いません。このStepはBitriseにアーティファクトを公開するものであり、特定のプラットフォームに限定されません。

expo.ioに公開する必要がある場合は、Expo EjectStepのRun expo publish after eject?入力をyesに設定します。その場合、expo.ioに公開するために、Expoアカウントのユーザー名とパスワードを入力する必要がある点に注意してください。

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

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

  3. WorkflowにDeploy to bitrise.ioStepがあることを確認してください。

  4. Notify: User Rolesで、このロールが付与されているユーザーのみに通知が届くようにロールを追加します。または、通知したいユーザーのメールアドレスをNotify: Emailsフィールドに入力します。

    これらのメールアドレスは必ずSecretsとして設定してください。これらの詳細は、Artifactsタブで生成されたバイナリの横にあるeyeアイコンをクリックすると、Notificationsの下でも変更できます。

  5. Stepにパブリックインストールページを生成させたい場合は、Enable public page for the App?入力をtrueに設定します。

AndroidプロジェクトをGoogle PlayにデプロイするClick to copy link​

WorkflowのDeploy to Google PlayStepを使用して、デジタル署名済みのAAB/APKをGoogle Play Storeにアップロードできます。

  1. Cordova archiveまたはIonic archiveStepをWorkflowに追加します。

    1つのプロジェクトでiOSとAndroidの両方向けにビルドしている場合、いずれかのアプリが失敗すると、Cordova archive/Ionic archiveStep全体が失敗する点に注意してください。

  2. 必要な入力項目を入力します。

    • Platform to use in cordova-cli commands(Cordova)またはPlatform to use in ionic-cli commands(Ionic)をandroid(両方のプラットフォーム向けにビルドする場合はios,android)に設定します。
    • Build command targetをdeviceに設定します。
    • Build command configurationの入力は、Generate cordova build configurationStepのBuild configuration入力と一致させる必要があります。

    archive Stepは、Workflow内のGenerate cordova build configurationStepの後に配置する必要があります。

  3. アプリ用にcode signingを設定します。

  4. Google Playアクセスを設定します。

    これは、アプリの初めてのGoogle Playデプロイの際にのみ必要です。

  5. Workflow内のAndroid SignとCordova ArchiveまたはIonic ArchiveStepの後に、Deploy to Google PlayStepがあることを確認してください。

  6. 必要な入力フィールドを以下のように入力します。

    • Service Account JSON key file path: このフィールドはリモートのURLを受け付けるため、アップロード済みのサービスアカウントJSONキーを含む環境変数(Env Var)を指定する必要があります。例: $BITRISEIO_SERVICE_ACCOUNT_JSON_KEY_URL。
    • Package name: Androidアプリのpackage name。
    • Track: APKをデプロイするトラック(例: alpha/beta/rollout/production、または設定した任意のカスタムトラック)。

iOSプロジェクトをApp StoreにデプロイするClick to copy link​

  1. Cordova archiveまたはIonic archiveStepをWorkflowに追加します。

    1つのプロジェクトでiOSとAndroidの両方向けにビルドしている場合、いずれかのアプリが失敗すると、Cordova archive/Ionic archiveStep全体が失敗する点に注意してください。

  2. 必要な入力項目を入力します。

    • Platformの入力はdeviceに設定する必要があります。
    • Build command configurationの入力は、Generate cordova build configurationStepのBuild configuration入力と一致させる必要があります。

    archive Stepは、Workflow内のGenerate cordova build configurationStepの後に配置する必要があります。

  3. iOSプロジェクト用にiOSのcode signingを設定します。

  4. Deploy to App Store Connect - Application Loader (formerly iTunes Connect)StepをWorkflowに追加します。Xcode Archive & Export for iOSStepの後に配置しますが、Deploy to Bitrise.ioStepより前に配置することを推奨します。

  5. Deploy to App Store Connect - Application Loader (formerly iTunes Connect)StepにAppleの認証情報を入力します。

    Stepには、以下が必要です。

    • Apple ID。
    • パスワード。App Store Connectで2要素認証を使用している場合はアプリケーションパスワード。

    ご安心ください。パスワードはログに表示されたり、外部に公開されたりすることはありません。

  6. ビルドを開始します。