Electron Updater

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

@capgo/electron-updater gives Electron apps the same Capgo live-update model as @capgo/capacitor-updaterSie initialisieren es im Hauptprozess, exposieren den Renderer-Brückenschalter über Präloader und rufen es auf notifyAppReady() auf jeder Start so dass die Rollback-Schutzfunktion weiß, dass das Bundle gesund ist.

Installation

bun add @capgo/electron-updater

Einstellung des Hauptprozesses

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

Vorkompilierungszugriff

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

exposeUpdaterAPI();

Verwendung des Renderers

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

Hören Sie auf Update-Ereignisse

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

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

Bereitstellung eines neuen Bundles

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

Praktische Tipps

• Rufen Sie immer auf notifyAppReady() frühzeitig im Renderer, damit die Rollback-Schutzfunktion wie vorgesehen funktioniert.
• Halten Sie den internen Pfad stabil und lassen Sie den Updater entscheiden, ob das gelieferte Bundle oder ein heruntergeladenenes verwendet werden soll.
• Wiederholen Sie den gleichen Capgo-Kanal und Rollout-Modell, das Sie bereits auf mobilen Geräten verwenden, wenn Ihr Electron-App einen Backend-Release-Pipeline teilt.

Bleiben Sie bei Using @capgo/electron-updater

Wenn Sie Using verwenden Using @capgo/electron-updater Um native Plugin-Arbeit zu planen, verbinden Sie es mit @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 Hinzufügen oder Aktualisieren von Plugins zur Implementierungsdetail in Hinzufügen oder Aktualisieren von Plugins.