メインコンテンツにジャンプ
@capgo/エレクトロンアップデーター アップデート オープンソース

エレクトロンプラグイン エレクトロンアプリのOTAライブアップデート

エレクトロンのアプリケーション向けのOTAライブアップデート機能は、APIのインターフェイスを共有するcapacitor-updaterと同様です。

Install

bun add @capgo/electron-updater
npm, pnpm または yarn
  • npm install @capgo/electron-updater
  • pnpm add @capgo/electron-updater
  • yarn add @capgo/electron-updater

ガイド

Electron アップデートの使用方法

Electronで@capgo/electron-updaterを使用

@capgo/electron-updater CapgoのライブアップデートモデルをElectronアプリに与える @capgo/capacitor-updaterを実行すると、Electronアプリに__CAPGO_KEEP_0__のライブアップデートモデルが与えられます。 notifyAppReady() を初期化して、メインプロセスで実行し、プリロードでレンダラーのブリッジを公開し、

Installation

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();

プリロードブリッジ

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() レンダラー内で早く呼び出すことにより、ロールバック保護が意図どおりに機能するようにします。
  • ビルトインパスを安定させ、アップデータが配布されたバンドルかダウンロードしたバンドルを読み込むかを決定するようにします。
  • 既存のモバイルアプリでバックエンドリリースパイプラインを共有しているElectronアプリでは、同じCapgoチャンネルとロールアウトモデルを再利用してください。

Using @capgo/electron-updater

あなたが使用している @capgo/エレクトロンアップデーター native plugin work を計画するには、を接続する @capgo/エレクトロンアップデーター @capgo/electron-updaterの実装詳細 Electron アップデータの導入 Getting Started with Electron Updaterの実装詳細 Capgo プラグイン ディレクトリ Capgo プラグイン ディレクトリの製品ワークフロー用 Capacitor プラグイン (Capgo によって提供) Capacitor プラグイン (Capgo によって提供)の実装詳細 プラグインの追加または更新 __CAPGO_KEEP_0__ プラグイン (__CAPGO_KEEP_1__ によって提供)の実装詳細

FAQ

エレクトロンアップデーター プラグインのFAQ

エレクトロンアップデーター プラグインをエレクトロンアプリにインストールするにはどのようにしますか?

bunに「capgo/electron-updater」を追加し(または「npmで「capgo/electron-updater」をインストールし)、エレクトロン設定の手順に従い、GitHub READMEを参照してください。

@capgo/エレクトロンアップデーターは、React、Vue、Angularとどのどのフレームワークでも動作しますか。

はい。エレクトロンアップデーターはエレクトロンパッケージなので、React、Vue、Angular、Svelte、または単純なJavaScriptで動作します。

エレクトロンアップデーターは@capgo/electron-updater無料でオープンソースですか?

Yes. The source code is public on GitHub at https://github.com/Cap-go/electron-updater/ and the package is free to install from npm. Bug reports and pull requests are welcome.

エレクトロン アップデートの変更をアプリレビューの待たずに配信

プラグインがストアビルドに追加されたら、Capgo ライブ アップデートは、JavaScript、HTML、CSS の変更をユーザーに 1 分間で反映します。

Capgo で始めましょう