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

概要

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

Live Updatesの仕組み

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

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

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

  2. ユーザーの特定のグループに更新を配信するためのチャネル。チャネルを使用して、以下のような異なるリリーストラックを管理できます。 Production, Stagingや Dev.

新しい JS バンドルを Capgo にアップロードしてチャネルに割り当てると、そのチャネルに設定されたアプリ内の Capgo SDK が更新を検出し、ダウンロードします。次にアプリを再起動すると、新しいバンドルが読み込まれます。

スタートガイド

「はじめに」セクション

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 テスト、マネージャー承認などの独自プロセスを挿入できる
  • 既存の DevOps ツールやワークフローに Capgo を統合できる

認証

セクション「認証」

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

API キーでログインし、安全に保存するには、次を実行します：

ターミナル
npx @capgo/cli@latest login [API_KEY]

このコマンドは今後利用できるよう保存されます。ログイン後は、コマンドごとに API キーを指定する必要はありません。

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

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

他の live update CLI ツールに慣れている方でも、Capgo の CLI にはいくつか注意すべき点があります。

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

  • Capgo の CLI は、別途インストールする必要はありません。 @capgo/cli パッケージにバンドルされており、 npx.

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

次のステップ

「次のステップ」セクション

チャンネル

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

ロールバック

アップデートにより問題が発生した場合に、以前のJS bundleバージョンへロールバックする方法を確認しましょう。

アップデートの動作

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

高速アップデート

アップデート処理を高速化する高速アップデートの使い方を学びましょう。

Overviewから続ける

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

使用している場合 概要 ダッシュボードと API の運用を計画するには、これを次と連携させます API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー API Keys の実装の詳細については、 デバイス Devices の実装詳細については、および Bundle Bundlesの実装詳細については