Lompat ke konten utama
Kembali ke plugin
@capgo/electron-updater
Tutorial
@capgo/electron-updater

Pembaruan Electron

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

Panduan

Tutorial Electron Updater

Menggunakan @capgo/electron-updater

@capgo/electron-updater memberikan aplikasi Electron model pembaruan hidup yang sama seperti Capgo @capgo/capacitor-updater Anda menginisialisasinya di proses utama, mengekspos jembatan renderer melalui preload, dan memanggil notifyAppReady() on setiap peluncuran sehingga perlindungan rollback tahu bundel sehat.

Pemasangan

bun add @capgo/electron-updater

Pengaturan proses utama

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

Jembatan preload

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

exposeUpdaterAPI();

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

Dengarkan event pembaruan

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

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

Tetapkan bundle baru

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

Saran Praktis

  • Selalu panggil notifyAppReady() dini dalam renderer agar proteksi rollback berfungsi sebagaimana mestinya.
  • Tetapkan jalur path yang dibangun stabil dan biarkan pembaruan menentukan apakah harus memuat bundle yang dikirim atau yang diunduh.
  • Gunakan saluran dan model peluncuran yang sama dengan Capgo yang sudah digunakan di mobile ketika aplikasi Electron Anda berbagi jalur pipa rilis backend.

Lanjutkan dari Menggunakan @capgo/electron-updater

Jika Anda menggunakan Menggunakan @capgo/electron-updater untuk merencanakan pekerjaan plugin native, hubungkannya dengan Untuk @capgo/electron-updater Untuk detail implementasi di @capgo/electron-updater Mulai Membangun dengan Electron Updater Untuk detail implementasi di Mulai Membangun dengan Electron Updater Daftar Plugin @Capgo Untuk alur kerja produk di Daftar Plugin @Capgo Plugin @Capacitor oleh @Capgo Untuk detail implementasi di Plugin @Capacitor oleh @Capgo, dan Menambahkan atau Mengupdate Plugin Untuk detail implementasi di Menambahkan atau Mengupdate Plugin.