Richtlinie
Tutorial zum Electron-Updater
Mit @capgo/electron-updater
@capgo/electron-updater gibt Electron-Anwendungen das gleiche Capgo-Live-Update-Modell wie @capgo/capacitor-updaterSie initialisieren es im Hauptprozess, exposieren den Renderer-Brückenschalter über preload und rufen notifyAppReady() auf jeden Start auf, damit die Rollback-Schutzfunktion weiß, dass das Bundle gesund ist.
Installation
bun add @capgo/electron-updater
Hauptprozess-Einrichtung
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());
});
Preload-Brücke
import { exposeUpdaterAPI } from '@capgo/electron-updater/preload';
exposeUpdaterAPI();
Renderer-Verwendung
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);
});
Ein neues Bundle bereitstellen
bun run build
bunx @capgo/cli@latest bundle upload --channel=production
Praktische Tipps
- Rufen Sie immer auf
notifyAppReady()frühzeitig im Renderer, damit die Rollover-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 die gleiche Capgo-Kanal- und Rollout-Modell, das Sie bereits auf mobilen Geräten verwenden, wenn Ihr Electron-App einen Backend-Release-Pipeline teilt.
Fortsetzen Sie von Using @capgo/electron-updater
Wenn Sie " Using @capgo/electron-updater für die Planung von nativen Plugin-Arbeiten verwenden, verbinden Sie es mit @capgo/electron-updater für die Implementierungsdetails in @capgo/electron-updater, Einstieg in Electron Updater für die Implementierungsdetails in Einstieg in Electron Updater Capgo Plugin-Ordner für den Produktworkflow in Capgo Plugin-Ordner Capacitor Plugins von Capgo für die Implementierungsdetails in Capacitor Plugins von Capgo, und Hinzufügen oder Aktualisieren von Plugins für die Implementierungsdetails in Hinzufügen oder Aktualisieren von Plugins.