Guida
Come usare Electron Updater in Electron
Utilizzo di @capgo/electron-updater
@capgo/electron-updater fornisce alle app Electron lo stesso modello di live-update Capgo di @capgo/capacitor-updater. Lo inizializzi nel main process, esponi il bridge del renderer tramite preload e chiami notifyAppReady() a ogni avvio, in modo che la protezione dal rollback sappia che il bundle è sano.
Installazione
bun add @capgo/electron-updater
Configurazione del processo principale
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());
});
Bridge di preload
import { exposeUpdaterAPI } from '@capgo/electron-updater/preload';
exposeUpdaterAPI();
Uso nel renderer
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 });
}
Ascolta gli eventi di aggiornamento
updater.addListener('download', ({ percent }) => {
console.log('Download progress', percent);
});
updater.addListener('updateFailed', ({ bundle }) => {
console.error('Update failed', bundle.version);
});
Deploy di un nuovo bundle
bun run build
bunx @capgo/cli@latest bundle upload --channel=production
Consigli pratici
- Chiamare sempre
notifyAppReady()all'inizio del renderer, così la protezione dal rollback funziona come previsto. - Mantieni stabile il percorso integrato e lascia che l'updater decida se caricare il bundle spedito o uno scaricato.
- Riutilizza lo stesso canale Capgo e modello di rollout già in uso su mobile, se la tua app Electron condivide un pipeline di release del backend.
Continua da Utilizzo di @capgo/electron-updater
Se stai usando Utilizzo di @capgo/electron-updater per pianificare il lavoro sui plugin nativi, collegalo a @capgo/electron-updater per i dettagli di implementazione in @capgo/electron-updater, Guida rapida a Electron Updater per i dettagli di implementazione in Guida introduttiva a Electron Updater, Directory dei plugin di Capgo per il workflow del prodotto nella Capgo Plugin Directory, Plugin Capacitor di Capgo per i dettagli di implementazione in Plugin Capacitor di Capgo, e Aggiunta o aggiornamento dei plugin per i dettagli di implementazione in Aggiunta o aggiornamento dei plugin.