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

Bitrise CIでのCodePushアップデートのリリース

CodePushアップデートは、Bitrise CI Workflowでリリースできます。このプロセスには次のものが必要です。

  • CodePush認証情報の設定: アプリID、deployment name、ターゲットバージョン、Bitrise APIトークンを保持するEnvironment Variablesとシークレットを作成します。
  • Workflowの作成: iOSとAndroidの両方のアップデートパッケージを作成し、両方をBitriseにアップロードします。

BitriseでのCodePush認証情報の設定Click to copy link​

  1. Release ManagementのアプリID(確認方法)とCodePush deploymentsの名前を取得します。

  2. 接続されたアプリID、deployment name、ターゲットバージョン用のEnvironment Variablesを作成します。

    • IOS_CONNECTED_APP_ID: iOSアプリのアプリID。
    • ANDROID_CONNECTED_APP_ID: AndroidアプリのアプリID。
    • CODEPUSH_DEPLOYMENT: リリース先のデプロイの名前(例: Staging)。
    • APP_TARGET_VERSIONS: アップデートを受け取るアプリバージョン。正確なバージョンまたは範囲式を使用します(例: 1.2.0または>=1.5.0)。

    デプロイはアプリに属するため、iOSアプリとAndroidアプリにはそれぞれ独自のデプロイがあります。2つのデプロイには同じ名前を付けることができます(例: Staging)。その場合、CODEPUSH_DEPLOYMENTをStagingに設定すると、Bitriseが各アプリに対応するデプロイを見つけます。

    Bitriseは、アップデートがアプリバージョンのネイティブコードで動作するかどうかを確認できません。互換性のあるバージョンはご自身で判断するため、各リリースの前にAPP_TARGET_VERSIONSを設定してください。

  3. 個人用アクセストークンまたはworkspace APIトークンを保持する、BITRISE_API_TOKENという名前のシークレットを作成します。

CodePushアップデート用のWorkflowの作成Click to copy link​

このセクションでは、次の処理を行うCI Workflowの作成方法を説明します。

  • iOS用のアップデートパッケージを作成します。
  • iOSのアップデートパッケージをBitriseにアップロードします。
  • Android用のアップデートパッケージを作成します。
  • AndroidのアップデートパッケージをBitriseにアップロードします。

これらのアップデートパッケージの作成とアップロードには、Bitrise CodePush Publish StepまたはCodePush CLIのどちらかを使用できます。どちらもプロジェクトがbare React NativeとExpoのどちらを使用しているかを検出し、1回の実行で1つのプラットフォームを処理します。そのため、iOS用に1回、Android用に1回追加してください。

Bitrise CodePush Publish Stepの使用Click to copy link​

ほとんどのプロジェクトにはStepをお勧めします。JavaScriptの依存関係をインストールし、アプリをバンドルして、アップデートをアップロードします。git-clone Stepの後に、プラットフォームごとに1回ずつ追加してください。

workflows:
codepush_update_deploy:
steps:
- git-clone@8: {}
- codepush-publish@1:
title: Publish iOS update
inputs:
- platform: ios
- app_id: $IOS_CONNECTED_APP_ID
- deployment: $CODEPUSH_DEPLOYMENT
- app_version: $APP_TARGET_VERSIONS
- api_token: $BITRISE_API_TOKEN
- codepush-publish@1:
title: Publish Android update
inputs:
- platform: android
- app_id: $ANDROID_CONNECTED_APP_ID
- deployment: $CODEPUSH_DEPLOYMENT
- app_version: $APP_TARGET_VERSIONS
- api_token: $BITRISE_API_TOKEN

Stepには、rollout_percentage、mandatory、descriptionなどのオプションの入力もあります。エントリファイルとHermesの設定は自動的に検出され、entry_fileとhermesで上書きできます。前のStepですでに依存関係をインストールしている場合は、skip_dependency_installを"true"に設定してください。

アップデートに署名するには、秘密鍵をSecret Fileとしてアップロードし、private_key_pathにその環境変数(例: $CODEPUSH_PRIVATE_KEY)を設定します。

Stepはアップデートパッケージを$BITRISE_DEPLOY_DIRにエクスポートするため、後続のDeploy to Bitrise.io Stepがそれをビルドのアーティファクトに追加します。

CodePush CLIの使用Click to copy link​

アップデートの公開以外の操作が必要な場合(たとえば、リリースを別のデプロイに昇格させたり、ロールバックしたりする場合)は、CLIを使用します。CodePush CLIプラグインと依存関係をインストールしてから、プラットフォームごとに1回ずつpush --bundleを実行します。このコマンドはJavaScriptをバンドルし、アップデートをアップロードします。CLIは環境からBITRISE_API_TOKENを自動的に読み取ります。

workflows:
codepush_update_deploy:
steps:
- git-clone@8: {}
- script@1:
title: Install the CodePush CLI
inputs:
- content: bitrise plugin install https://github.com/bitrise-io/bitrise-plugins-codepush-cli.git
- npm@1:
inputs:
- command: install
- script@1:
title: Push iOS update
inputs:
- content: |-
bitrise :codepush push --bundle --platform ios \
--app-id "$IOS_CONNECTED_APP_ID" \
--deployment "$CODEPUSH_DEPLOYMENT" \
--app-version "$APP_TARGET_VERSIONS"
- script@1:
title: Push Android update
inputs:
- content: |-
bitrise :codepush push --bundle --platform android \
--app-id "$ANDROID_CONNECTED_APP_ID" \
--deployment "$CODEPUSH_DEPLOYMENT" \
--app-version "$APP_TARGET_VERSIONS"

Bitriseビルドでは、CLIがビルド番号とコミットハッシュをアップデートに付加します。また、アップデートIDを次のStepsにエクスポートします。すべてのコマンドとフラグについては、CodePush CLIリファレンスを参照してください。

CodePushアップデートリリースの自動化Click to copy link​

CodePushアップデートを生成してアップロードするWorkflowを作成したら、次の2つの方法で実行できます。

さまざまな種類のトリガーを設定して、プロセスを自動化できます。この設定例では、ラベルを使ったプルリクエストトリガーを使用します。

プルリクエストにラベルが付いたときにCodePushアップデートをリリースする

この例では、いずれかのプルリクエストにrelease-updateラベルが付いたときにcodepush_update_deploy Workflowが実行されるトリガーを設定します。マージする前のテストとして、プルリクエストをStagingなどのデプロイにリリースする場合に使用します。

  1. トリガーを作成します。label条件をrelease-updateに設定したプルリクエストトリガーを設定します。target_branch条件のデフォルトは*のため、すべてのブランチへのプルリクエストが一致します。リリースを1つのブランチに限定するには、target_branchも設定してください。

    GUI設定

    これらはWorkflow EditorのGUIでも設定できます。ここではYAMLの設定を示しています。

    format_version: "13"
    default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
    project_type: react-native
    workflows:
    codepush_update_deploy:
    status_report_name: 'Executing <target_id> for <project_title>'
    description: |
    Uploads Update Bundle to Bitrise
    steps:
    [...]
    triggers:
    pull_request:
    - label: release-update
  2. CodePushアップデートをリリースするときは、プルリクエストを作成します。

  3. プルリクエストがレビューされて承認されたら、release-updateラベルを追加します。

注記

Bitriseは、ラベルを追加した時点で、プルリクエストがマージされる前にビルドを実行します。アップデートはプルリクエストのコードからリリースされます。