CodePush CLI の使用
この例ではプラグインモードの構文を使用しています。スタンドアロンモードでは、bitrise :codepush を codepush に置き換えてください。
すべてのコマンド、フラグ、environment variablesの概要については、CodePush CLI referenceをご覧ください。
プロジェクトのセットアップClick to copy link
CodePush CLIのインストールと認証の設定が完了したら、プロジェクトを初期化して、アプリIDをローカルに保存します。
bitrise :codepush init
このコマンドは、カレントディレクトリに.codepush.jsonファイルを作成します。このファイルをバージョン管理にコミットすると、チームで同じ設定を共有できます。
initを初めて実行すると、CLIがアプリIDの入力を求めます。アプリIDは、Release ManagementのアプリのURLから取得できます: https://app.bitrise.io/release-management/workspaces/<workspace-slug>/connected-apps/<app-id>/、またはAPI経由で取得できます。
Enter your app ID (UUID):
>a3f47d2c-6b9e-4f1a-9d2b-7c8e5a1b2c3d
--app-idで直接指定するか、CODEPUSH_APP_ID環境変数を設定することもできます。CLIは、次の順序でアプリIDを解決します。
--app-idフラグ (最優先)CODEPUSH_APP_ID環境変数.codepush.json内のapp_idフィールド
既存の.codepush.jsonを上書きするには、次のようにします。
bitrise :codepush init --force --app-id a3f47d2c-6b9e-4f1a-9d2b-7c8e5a1b2c3d
Release managementClick to copy link
アプリのバンドルClick to copy link
bundleコマンドは、React NativeおよびExpoプロジェクト向けのJavaScriptバンドルを生成します。プロジェクトの種類、エントリーファイル、Hermesの設定、Metroの設定を自動で検出します。
プラットフォームごとに個別にアプリをバンドルします。
bitrise :codepush bundle --platform ios
bitrise :codepush bundle --platform android
自動検出に失敗した場合は、関連するフラグを手動で指定します。
bitrise :codepush bundle --platform ios \
--entry-file index.js \
--config metro.config.js \
--pod-file ios/Podfile
Hermesを使用するAndroidでは、--pod-fileの代わりに--gradle-fileを使用します。
bitrise :codepush bundle --platform android \
--entry-file index.js \
--gradle-file android/app/build.gradle
CLIは、デフォルトでソースマップを生成し、pushがアップロードするバンドルディレクトリの外にある<output-dir>.sourcemaps/<bundle-name>.mapに書き込みます。別の場所に書き込むには、--sourcemap-output (-s) を使用します。パスは出力ディレクトリの外にする必要があります。
bitrise :codepush bundle --platform ios \
--sourcemap-output ./sourcemaps/main.jsbundle.map
バンドルとプッシュを1ステップで行う場合、push --bundleは同じ--sourcemapフラグと--sourcemap-outputフラグを受け付けます。
アップデートのプッシュClick to copy link
pushコマンドは、ビルド済みのバンドルをCodePushサーバーにアップロードします。デプロイとアプリバージョンを指定する必要があります。
bitrise :codepush push ./codepush-bundle \
--deployment Staging --app-version 1.0.0
--bundleフラグを使用すると、バンドルとプッシュを1ステップで行うこともできます。
bitrise :codepush push --bundle --platform ios \
--deployment Staging --app-version 1.0.0
リリースのプロモートClick to copy link
promoteコマンドは、あるデプロイから別のデプロイにリリースをコピーします。ステージング環境から本番環境へリリースを移行する際に最もよく使用されます。
bitrise :codepush promote \
--source-deployment Staging \
--destination-deployment Production \
--rollout 25 --description "Gradual rollout"
対象のデプロイに同一内容のリリースがすでに存在する場合に、エラーではなく警告付きで終了コード0で終了するには、--no-duplicate-release-errorを指定します。
リリースのパッチ適用Click to copy link
patchコマンドは、コードを再デプロイせずに、既存のリリースのメタデータを更新します。
ラベルを指定して特定のリリースにパッチを適用します。
bitrise :codepush patch --deployment Production --label v5 --mandatory true
最新のリリースのrollout percentageを引き上げます。
bitrise :codepush patch --deployment Production --rollout 50
ロールバックClick to copy link
rollbackコマンドは、以前のバージョンを再現する新しいリリースを作成します。
直前のリリースにロールバックします。
bitrise :codepush rollback --deployment Production
ラベルを指定して特定のリリースにロールバックします。
bitrise :codepush rollback --deployment Production --target-release v3
デプロイの管理Click to copy link
デプロイを作成して、デプロイキーを取得します。アプリにCodePushアップデートをリリースするには、デプロイキーが必要です。
すべてのデプロイを一覧表示します。
bitrise :codepush deployment list
bitrise :codepush deployment list --display-keys # include deployment keys
新しいデプロイを作成します。
bitrise :codepush deployment add Beta
カスタムのデプロイキーを指定して新しいデプロイを作成します。
bitrise :codepush deployment add Beta --key my-custom-key
デプロイの詳細と最新のリリースを表示します。
bitrise :codepush deployment info Staging
リリース履歴を表示します。デフォルトでは、直近10件のリリースが表示されます。
bitrise :codepush deployment history Staging
bitrise :codepush deployment history Staging --limit 25
bitrise :codepush deployment history Staging --display-author
デプロイの名前を変更します。
bitrise :codepush deployment rename OldName --name NewName
デプロイからすべてのリリースを消去します。これは破壊的な操作です。CIで確認プロンプトをスキップするには、--yesを指定します。
bitrise :codepush deployment clear Staging --yes
デプロイを削除します。これは破壊的な操作です。CIで確認プロンプトをスキップするには、--yesを指定します。
bitrise :codepush deployment remove Beta --yes
アップデートの管理Click to copy link
デプロイ内の最新アップデートの詳細を表示します。
bitrise :codepush update info Staging
ラベルを指定して特定のアップデートを表示します。
bitrise :codepush update info Staging --label v5
アップデートの処理ステータスを確認します。これは、プッシュ後にアップデートが受け付けられたことを確認するのに便利です。出力には、デルタ生成の状態と、以前の各アップデートに保存されているデルタの種類も表示されます。--jsonを指定すると、同じデータがdelta_generation_status、deltas、update_versionsに含まれます。詳しくはデルタアップデートを参照してください。
bitrise :codepush update status Staging
特定のアップデートを削除します。--labelでアップデートを指定し、--yesで確定します。
bitrise :codepush update remove Staging --label v3 --yes
JSON出力Click to copy link
任意のコマンドに--jsonを指定すると、機械可読なJSON出力が stdout に出力されます。人間が読める出力は常に stderr に出力されるため、JSON出力はパイプ処理に適したクリーンな状態になります。
プッシュ結果をJSONで取得します。
bitrise :codepush push ./CodePush \
--deployment Staging --app-version 1.0.0 --json
デプロイをJSONで一覧表示します。
bitrise :codepush deployment list --json
jqで出力を解析します。
bitrise :codepush update info Staging --json | jq '.app_version'
Bitrise CIとの統合Click to copy link
CLIは、BITRISE_BUILD_NUMBERまたはBITRISE_DEPLOY_DIRenvironment variablesからBitrise CI環境を検出します。Bitriseビルド内で実行すると、CLIは自動的に次の処理を行います。
- ビルド番号とコミットハッシュをプッシュのメタデータに付加します。
- バンドル後に
codepush-bundle-summary.jsonをエクスポートします。 - プッシュ後に
codepush-push-summary.jsonをエクスポートします。 - パッチ適用後に
codepush-patch-summary.jsonをエクスポートします。 - 後続の Step で使用できるように、
envman経由でenvironment variablesをエクスポートします。 - 対話型のプロンプトとスピナーを無効にします。
Workflowの例Click to copy link
リリースライフサイクル全体Click to copy link
-
Bitrise API トークンで認証します。
bitrise :codepush auth login --token $BITRISE_API_TOKEN -
対象プラットフォーム向けにJavaScriptをバンドルします。
bitrise :codepush bundle --platform ios -
限定的なロールアウトで Staging にプッシュします。
bitrise :codepush push ./CodePush \--deployment Staging \--app-version 1.2.0 --rollout 10 --description "Fix login crash" -
処理ステータスを確認して、アップデートが受理されたことを確かめます。
bitrise :codepush update status Staging -
テストデバイスで確認した後、ロールアウトを引き上げます。
bitrise :codepush patch --deployment Staging --rollout 100 -
Production にプロモートします。
bitrise :codepush promote \--source-deployment Staging \--destination-deployment Production \--rollout 25 -
問題が発生した場合は、ロールバックします。
bitrise :codepush rollback --deployment Production
Bitrise CIパイプラインClick to copy link
Bitrise Workflowで、BITRISE_API_TOKEN、CODEPUSH_APP_ID、CODEPUSH_DEPLOYMENTをenvironment variablesとして設定し、次のコマンドを1つ実行します。
bitrise :codepush push --bundle --platform ios --app-version $APP_VERSION
CLIはBitrise環境を自動的に検出し、ビルドのメタデータ (ビルド番号とコミットハッシュ) を付加して、サマリーファイルを$BITRISE_DEPLOY_DIRにエクスポートします。
ExpoワークフローClick to copy link
Expoはpackage.jsonから自動検出されるため、追加のフラグは不要です。CLIは、内部でreact-native bundleの代わりにnpx expo export:embedを使用します。その他のフラグ (デプロイ、アプリバージョン、ロールアウトなど) は、まったく同じように動作します。
bitrise :codepush push --bundle --platform ios \
--deployment Staging \
--app-version 1.0.0
2つのフラグでバンドラーの動作を制御します。
--minify(デフォルトはfalse): バンドルを minify するかどうかを指定します。デバッグしやすいように、デフォルトでは無効になっています。バンドルを最小サイズにするには、--minify=trueを設定します。--reset-cache(デフォルトはtrue): 実行のたびに Metro バンドラーのキャッシュをクリアして、クリーンな出力を保証します。キャッシュのクリアをスキップして、ローカルでの繰り返し実行を高速化するには、--reset-cache=falseを設定します。