__CAPGO_KEEP_0__ Startseite
Zurück zu Plugins
@capgo/electron-updater
Anleitung
@capgo/electron-updater

Electron Updater

OTA live updates for Electron apps with the same API surface as capacitor-updater

Anleitung

Tutorial zum Electron-Updater

Mit @capgo/electron-updater erhalten Electron-Anwendungen das gleiche capgo-Live-Update-Modell wie

@capgo/electron-updater gives Electron apps the same Capgo live-update model as @capgo/capacitor-updaterInstallation notifyAppReady() Hauptprozess-Einrichtung

Präloader-Brücke

bun add @capgo/electron-updater

gibt Electron-Anwendungen das gleiche __CAPGO_KEEP_0__-Live-Update-Modell wie

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

Sie initialisieren es im Hauptprozess, stellen den Renderer-Brücke über den Präloader bereit und rufen

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

exposeUpdaterAPI();

Renderer-Anwendung

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

Update-Ereignisse abrufen

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

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

Ein neues Bundle bereitstellen

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

Praktische Tipps

  • Stets aufrufen notifyAppReady() frühzeitig im Renderer, damit die Rollover-Schutzfunktion wie gewünscht funktioniert.
  • Halten Sie den internen Pfad stabil und lassen Sie den Updater entscheiden, ob die gelieferte oder eine heruntergeladene Version geladen werden soll.
  • Verwenden Sie denselben Capgo-Kanal und Rollout-Modell wie bereits auf mobilen Geräten, wenn Ihre Electron-Anwendung eine gemeinsame Backend-Release-Pipeline verwendet.

Weiterhin von @capgo/electron-updater verwenden

Wenn Sie @__CAPGO_KEEP_0__/electron-updater verwenden Using @capgo/electron-updater Weiterhin von @__CAPGO_KEEP_0__/electron-updater verwenden @capgo/electron-updater für die Implementierungsdetails in @capgo/electron-updater Einführung in Electron Updater für die Implementierungsdetails in Einführung in Electron Updater Capgo Plugin-Verzeichnis für den Produktworkflow in Capgo Plugin-Verzeichnis Capacitor Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins von Capgo, und Plugins hinzufügen oder aktualisieren für die Implementierungsdetails in Plugins hinzufügen oder aktualisieren