メインコンテンツへスキップ
Capgo - Capacitor アプリのビルド、リリース、アップデート Capgo

概要

CapgoのLive Updates機能を使えば、アプリのJavaScript bundleをリモートかつリアルタイムに更新できます。App Storeの審査を通さずにJSアップデートをユーザーへ直接配信できるため、バグの即時修正や新機能の迅速なリリースが可能です。

Live Updates の仕組み

「Live Updates の仕組み」セクション

Capgo の Live Update システムには、2つの主要コンポーネントがあります：

  1. アプリにインストールする Capgo の SDK。SDK が利用可能なアップデートを確認し、バックグラウンドでダウンロードします。

  2. 特定のユーザーグループにアップデートを配信できる Channels。以下のような異なるリリーストラックの管理に使用できます： Production, Staging、および Dev.

Capgo に新しい JS bundle をアップロードし、チャンネルに割り当てると、そのチャンネル用に設定されたアプリ内の Capgo SDK がアップデートを検知してダウンロードします。次にアプリが再起動したときに、新しい bundle がロードされます。

はじめに

「はじめに」セクション

Live Updates の使用を開始するには、次の手順に従ってください：

  1. 次を完了してください Capgo クイックスタート Capgo でアプリをセットアップし、Capgo SDK をインストールします。

  2. アプリの code 内で、次を呼び出します： CapacitorUpdater.notifyAppReady() アプリの初期化が完了した後に実行してください。これにより、アプリがアップデートを受け取る準備ができたことを Capgo SDK に通知します。

  3. JS bundle をビルドして Capgo にアップロードします：

    ターミナルウィンドウ
    npm run build
    npx @capgo/cli@latest bundle upload --channel=production

  4. アプリを開き、アップデートがダウンロードされるのを待ちます。ステータスは以下で確認できます：

    ターミナルウィンドウ
    npx @capgo/cli@latest app debug

  5. アップデートがダウンロードされたら、アプリを閉じて再度開き、新しい bundle を読み込んでください。

次を参照： Live Updatesのデプロイ 詳細はガイドを参照してください。

Capgo CLI

「Capgo CLI」セクション

Capgo CLI は、開発者が自身の CI/CD パイプラインから Capgo のサービスを操作できる強力なツールです。CLI を使用することで、ビルドを作成してデプロイするタイミングを細かく制御でき、Capgo を既存のエンタープライズワークフローに統合できます。

Capgo CLI の用途は何ですか？

「Capgo CLI の用途は何ですか？」セクション

Capgo CLI は、live update のワークフローにおいて、より高度な制御と柔軟性を必要とする開発者やチーム向けに設計されています。CI/CD パイプラインで CLI を使用することで、以下のことが可能になります：

  • Capgo の組み込みの自動化に頼るのではなく、アップデートをビルドしてデプロイするタイミングを正確に決める
  • ビルドとデプロイのステップの間に、code の署名、QAテスト、マネージャーによる承認などの独自のプロセスを挿入する
  • Capgo を既存の DevOps ツールやワークフローに統合する

認証

「認証」セクション

Capgo CLI を使用するには、API キーによる認証が必要です。API キーは、Capgo のアカウント設定から生成できます。

ログインして API キーを安全に保存するには、以下を実行してください：

ターミナルウィンドウ
npx @capgo/cli@latest login [API_KEY]

このコマンドは次回以降のために保存されます。一度ログインすれば、以降のコマンドで毎回 API キーを入力する必要はありません。

他のCLIツールとの主な違い

「他の CLI ツールとの主な違い」セクション

他の live update CLI ツールに慣れている方なら、Capgo の CLI について押さえておきたいポイントがいくつかあります。

  • Capgo は live update 機能セットに特化しているため、Capgo は開発と CI/CD の両方のユースケースで単一の CLI を使用します。

  • Capgo の CLI は別途インストールする必要はありません。これは @capgo/cli パッケージに同梱されているので、以下を使って直接実行できます: npx.

  • Capgo の CLI は live update のワークフロー専用に設計されているため、より汎用的な CLI ツールにある一部の機能やコマンドが含まれていない場合があります。

次のステップ

「Next Steps」セクション

チャネル

チャンネルを使って、異なるリリーストラックを管理し、特定のユーザーにアップデートを配信する方法を学びましょう。

ロールバック

アップデートが原因で問題が発生した場合に、以前の JS bundle バージョンにロールバックする方法を紹介します。

Updateの挙動

アプリ内でアップデートをダウンロードして適用する方法とタイミングをカスタマイズします。

高速なアップデート

Fast Updatesを使ってアップデートプロセスを高速化する方法を学びます。

Overviewから続ける

「Overviewから続ける」セクション

以下を使用している場合： 概要 ダッシュボードと API の操作を計画するには、以下と連携してください API の概要 API Overview の実装の詳細については、 はじめに Introduction の実装の詳細については、 API キー API Keys の実装の詳細については、 デバイス Devices の実装の詳細、および バンドル Bundles の実装の詳細については、