メインコンテンツへスキップ
@capgo/capacitor-updater アップデート オープンソース

Updater Capacitor プラグイン

App Store の審査を待たずに、Ionic と Capacitor の Live Update をユーザーへ即座にデプロイ

インストール

bun add @capgo/capacitor-updater bunx cap sync
npm、pnpm、または yarn
  • npm install @capgo/capacitor-updater
  • pnpm add @capgo/capacitor-updater
  • yarn add @capgo/capacitor-updater

ガイド

Capacitor で Updater を使う方法

実機でテストする

Capgo アプリをダウンロードして、QR code をスキャンしてください。

Updaterプラグインプレビュー用QR code

IonicとCapacitorを@capgo/capacitor-updaterでLive Update

@capgo/capacitor-updaterは、IonicおよびCapacitorアプリ向けのCapgo Live Updateを支えるオープンソースのUpdaterプラグインです。承認済みのWeb bundleをダウンロードしてネイティブのロールバック保護機能とともに適用するため、バイナリのみの変更は通常のApp StoreやPlay Storeの審査プロセスに任せることができます。

ネイティブシェルが承認された後に、HTML、CSS、JavaScript、アセットなどのWebレイヤーの変更をOTAで更新したい場合に最適です。

インストール

npm install @capgo/capacitor-updater
npx cap sync

活用シーン

Ionicチームにとって、Live Updateは通常、全ユーザーにストアのフルリリースを強制することなく新しいWeb bundleを配信するというワークフローを意味します。Capgoは、チャンネル、互換性チェック、ロールアウト制御、デバイスログ、ロールバック機能により、Capacitorアプリのワークフローを管理します。

ネイティブプラグイン、Entitlements、Android Manifestの変更、iOS plistの変更、およびバイナリのSDKアップデートには、通常通りアプリストアでのリリースが必要です。これらの変更はネイティブのbuild pipelineで管理し、承認済みのWebレイヤーにはLive Updateを活用してください。

このプラグインで利用可能な機能

  • notifyAppReady - JavaScriptの初期化が正常に完了したことをネイティブレイヤーに通知します。
  • setUpdateUrl - アプリのアップデートURLをランタイム時に動的に設定します。
  • setStatsUrl - アプリの統計URLをランタイム時に動的に設定します。
  • setChannelUrl - アプリのチャネルURLをランタイム時に動的に設定します。

使用例

notifyAppReady

JavaScriptの初期化が正常に完了したことをネイティブレイヤーに通知します。

import { CapacitorUpdater } from '@capgo/capacitor-updater';

const result = await CapacitorUpdater.notifyAppReady();
console.log(result);

setUpdateUrl

アプリのアップデートURLをランタイム時に動的に設定します。

import { CapacitorUpdater } from '@capgo/capacitor-updater';

await CapacitorUpdater.setUpdateUrl({ url: 'https://example.com' });

setStatsUrl

アプリの統計URLをランタイム時に動的に設定します。

import { CapacitorUpdater } from '@capgo/capacitor-updater';

await CapacitorUpdater.setStatsUrl({ url: 'https://example.com' });

setChannelUrl

アプリのチャネルURLをランタイム時に動的に設定します。

import { CapacitorUpdater } from '@capgo/capacitor-updater';

await CapacitorUpdater.setChannelUrl({ url: 'https://example.com' });

リファレンス全文

@capgo/capacitor-updater でさらに進む

使用している場合 @capgo/capacitor-updater Live Update の計画を立てるには、以下と連携しましょう Live Update 製品ワークフローのために、 @capgo/capacitor-updater 実装の詳細については、 スタートガイド, チャンネルや ロールバック.

よくある質問

UpdaterプラグインのFAQ

CapacitorアプリにUpdaterプラグインをインストールするにはどうすればよいですか?

"bun add @capgo/capacitor-updater"(または"npm install @capgo/capacitor-updater")を実行した後、"bunx cap sync"を実行して、iOSおよびAndroidプロジェクトにネイティブのcodeを反映させてください。その後、アプリのcodeから"@capgo/capacitor-updater"をインポートします。

@capgo/capacitor-updaterはReact、Vue、Angularで動作しますか?

はい。UpdaterはCapacitorパッケージであるため、Ionic、React、Vue、Angular、Svelte、およびプレーンなJavaScriptを含む、Capacitor内で動作するあらゆるWebフレームワークで使用可能です。

@capgo/capacitor-updaterはどのCapacitorバージョンをサポートしていますか?

Capgo プラグインは Capacitor のメジャーバージョンに合わせています。使用している Capacitor のメジャーバージョンに一致するプラグインのメジャーバージョンを使ってください (例: Capacitor 8 ならプラグイン v8)。GitHub の README にある互換性テーブルに、メンテナンス中のバージョンが記載されています。

@capgo/capacitor-updaterは無料のオープンソースですか?

はい。codeのソースコードはGitHubの https://github.com/Cap-go/capacitor-updater/ で公開されており、パッケージはnpmから無料でインストールできます。バグ報告やプルリクエストも歓迎しています。

App Storeの審査なしで、Updaterを使用しているcodeをアップデートできますか?

プラグインのインストールやアップグレードはネイティブの code を変更するため、新しいストアビルドが必要です。その後は、プラグインを呼び出す JavaScript、HTML、CSS の変更を Capgo Live Updates で即座に配信できます。

アプリの審査を待たずに、Updaterの変更をリリース

プラグインをストア用ビルドに組み込めば、Capgo live updates で JavaScript、HTML、CSS の変更を数分でユーザーに配信できます

Capgo から始める