Guide
Tutoriel sur l'Actualisation Electron
En utilisant @capgo/electron-updater
@capgo/electron-updater gives Electron apps the same Capgo live-update model as @capgo/capacitor-updaterVous l'initialisez dans le processus principal, exposez le pont de rendu à travers preload, et appelez notifyAppReady() à chaque lancement afin que la protection de rollback sache que le bundle est sain.
Installation
bun add @capgo/electron-updater
Configuration du processus principal
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());
});
Pont de préchargement
import { exposeUpdaterAPI } from '@capgo/electron-updater/preload';
exposeUpdaterAPI();
Utilisation du rendu
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 });
}
Écoutez les événements de mise à jour
updater.addListener('download', ({ percent }) => {
console.log('Download progress', percent);
});
updater.addListener('updateFailed', ({ bundle }) => {
console.error('Update failed', bundle.version);
});
Déployez un nouveau bundle
bun run build
bunx @capgo/cli@latest bundle upload --channel=production
Conseils pratiques
- Appelez toujours
notifyAppReady()tôt dans le rendu afin que la protection de rollback fonctionne comme prévu. - Conservez la voie de construction intégrée stable et laissez l'actualiseur décider si charger le bundle embarqué ou un téléchargé.
- Réutilisez le même canal et modèle de déploiement Capgo que vous utilisez déjà sur mobile lorsque votre application Electron partage une pipeline de publication de backend.