Skip to main content
Back to plugins
@capgo/electron-updater
チュートリアル
@capgo/electron-updater

Electron Updater

Electron アプリケーションに API-updater と同じ capacitor サーフェイスを持つリアルタイムのOTA更新

ガイド

Electron アップデーターに関するチュートリアル

@capgo/electron-updaterを使用すると、Electron アプリに同様のライブアップデートモデルを提供します。

@capgo/electron-updater gives Electron apps the same Capgo live-update model as @capgo/capacitor-updater毎回起動することで、ロールバック保護がバンドルが正常であることを知ることができます。 notifyAppReady() インストール

メインプロセス設定

bun add @capgo/electron-updater

プリロード ブリッジ設定

import { app, BrowserWindow } from 'electron';
import path from 'node:path';
import { ElectronUpdater, setupEventForwarding, setupIPCHandlers } from '@capgo/electron-updater';

const updater = new ElectronUpdater({
  appId: 'com.example.desktop',
  autoUpdate: true,
});

app.whenReady().then(async () => {
  const window = new BrowserWindow({
    webPreferences: {
      preload: path.join(__dirname, 'preload.js'),
      contextIsolation: true,
    },
  });

  const builtinPath = path.join(__dirname, 'www/index.html');
  await updater.initialize(window, builtinPath);
  setupIPCHandlers(updater);
  setupEventForwarding(updater, window);

  await window.loadFile(updater.getCurrentBundlePath());
});

プリロード ブリッジ設定

import { exposeUpdaterAPI } from '@capgo/electron-updater/preload';

exposeUpdaterAPI();

Renderer usage

import { requireUpdater } from '@capgo/electron-updater/renderer';

const updater = requireUpdater();

await updater.notifyAppReady();

const latest = await updater.getLatest();

if (latest.url && !latest.error) {
  const bundle = await updater.download({
    url: latest.url,
    version: latest.version,
    checksum: latest.checksum,
  });

  await updater.next({ id: bundle.id });
}

更新イベントを待ち受ける

updater.addListener('download', ({ percent }) => {
  console.log('Download progress', percent);
});

updater.addListener('updateFailed', ({ bundle }) => {
  console.error('Update failed', bundle.version);
});

新しいバンドルをデプロイ

bun run build
bunx @capgo/cli@latest bundle upload --channel=production

実践的なアドバイス

  • 常に notifyAppReady() Renderer内で早期に呼び出すことにより、ロールバック保護が正常に機能するようにします。
  • 組み込まれたパスを安定させ、アップデーターが配布されたバンドルかダウンロードされたバンドルを読み込むかを決定するようにします。
  • 既存のモバイルアプリで使用している同じCapgoチャンネルとロールアウトモデルを再利用してください。Electronアプリがバックエンドリリースパイプラインを共有する場合です。

Using @capgo/electron-updater

から続けてください @capgo/electron-updater を使用している場合、ネイティブプラグインの作業を計画するには、接続してください。 @capgo/electron-updater @capgo/electron-updaterの実装詳細について Electron Updaterの導入 Electron Updaterの導入の実装詳細について Capgo プラグインディレクトリ Capgo プラグインディレクトリの製品ワークフローについて Capacitor プラグイン(Capgo) Capacitor プラグイン(Capgo)の実装詳細について プラグインの追加または更新 プラグインの追加または更新の実装詳細について