Zum Hauptinhalt springen
@capgo/electron-aktualisierer Updates Offene Quelle

Elektron-Updater Elektron-Plugin

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

Installieren

bun add @capgo/electron-updater
npm, pnpm oder yarn
  • npm install @capgo/electron-updater
  • pnpm add @capgo/electron-updater
  • yarn add @capgo/electron-updater

Richtlinie

So verwenden Sie Electron Updater in Electron

Mit @capgo/electron-updater

@capgo/electron-updater gibt Electron-Anwendungen das gleiche Capgo-Live-Update-Modell wie @capgo/capacitor-updaterSie initialisieren es im Hauptprozess, legen den Renderer-Brücke über den Präloader frei und rufen notifyAppReady() auf jeden Start auf, damit die Rollover-Schutzfunktion weiß, dass das Bundle gesund ist.

Installation

bun add @capgo/electron-updater

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

Preload-Brücke

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

exposeUpdaterAPI();

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

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

Bereitstellen 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 gewünscht funktioniert.
  • Halten Sie den internen Pfad stabil und lassen Sie den Updater entscheiden, ob er das gelieferte Bundle oder ein heruntergeladenenes laden soll.
  • Wiederholen Sie die gleiche Capgo-Kanal- und Rollout-Modell, das Sie bereits auf mobilen Geräten verwenden, wenn Ihre Electron-Anwendung eine gemeinsame Backend-Release-Pipeline verwendet.

Weitermachen von @capgo/electron-updater

If Sie Electron Updater verwenden Verwenden Sie @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 im Getting Started mit Electron Updater, um den Produktworkflow in @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 Zur Einführung in Electron Updater für die Implementierungsdetails in Plugins hinzufügen oder aktualisieren.

FAQ

FAQ zum Electron-Updater-Plugin

Wie installiere ich die Electron Updater-Plugin in einer Electron-Anwendung?

Führen Sie "bun add @capgo/electron-updater" (oder "npm install @capgo/electron-updater") aus, dann folgen Sie den Electron-Einrichtungsschritten in der Anleitung und dem GitHub README.

Funktioniert @capgo/electron-updater mit React, Vue und Angular?

Ja. Electron Updater ist ein Electron-Paket, daher funktioniert es mit jedem Webframework, das innerhalb von Electron, React, Vue, Angular, Svelte und plain JavaScript läuft.

Ist @capgo/electron-updater kostenlos und Open-Source?

Ja. Die Quelle code ist öffentlich auf GitHub unter https://github.com/Cap-go/electron-updater/ und das Paket ist kostenlos für die Installation von npm verfügbar. Bug-Berichte und Pull-Anfragen sind willkommen.

Elektron-Updates ohne Wartezeit für die App-Überprüfung

Sobald das Plugin in Ihrem Laden enthalten ist, Capgo Live-Updates drücken Ihre JavaScript-, HTML- und CSS-Änderungen an Benutzer in Minuten.

Mit Capgo beginnen