如何使用electron-builder及electron-updater给项目配置自动更新
时间: 2023-12-14 08:04:56 浏览: 342
使用electron-builder和electron-updater给项目配置自动更新可以分为以下几个步骤:
安装所需依赖:
在项目根目录下运行以下命令安装electron-builder和electron-updater:
npm install electron-builder electron-updater --save-dev
配置electron-builder:
在项目根目录下创建一个名为
electron-builder.json
的文件,用于配置构建选项。以下是一个示例配置文件:{ "appId": "com.example.app", "productName": "MyApp", "linux": { "target": "deb" }, "mac": { "target": "dmg", "category": "public.app-category.developer-tools" }, "win": { "target": [ { "target": "nsis", "arch": [ "x64", "ia32" ] } ] }, "directories": { "output": "build" }, "publish": { "provider": "github", "owner": "your-github-username", "repo": "your-github-repo", "private": true } }
上述示例配置文件中,
appId
是应用程序的ID,productName
是应用程序的名称,linux
、mac
、win
分别表示不同平台的构建选项,directories.output
指定构建输出目录,publish
配置用于自动更新的发布选项。
配置自动更新:
在主进程代码中,按照以下步骤进行配置:
const { app, autoUpdater } = require('electron'); const log = require('electron-log'); autoUpdater.logger = log; autoUpdater.logger.transports.file.level = 'info'; autoUpdater.setFeedURL({ provider: 'github', owner: 'your-github-username', repo: 'your-github-repo', private: true }); autoUpdater.on('update-available', () => { // 处理更新可用事件 }); autoUpdater.on('update-downloaded', () => { // 处理更新下载完成事件 autoUpdater.quitAndInstall(); }); app.on('ready', () => { if (process.env.NODE_ENV === 'production') { autoUpdater.checkForUpdates(); } });
上述代码中,
autoUpdater.setFeedURL
用于设置自动更新的URL,autoUpdater.on('update-available')
用于处理更新可用事件,autoUpdater.on('update-downloaded')
用于处理更新下载完成事件,autoUpdater.checkForUpdates()
用于检查更新。
构建和发布应用:
在项目根目录下运行以下命令构建应用:
npx electron-builder
构建完成后,可以将应用程序的安装包发布到GitHub等平台上。
以上就是使用electron-builder和electron-updater给项目配置自动更新的步骤。请根据自己的实际情况进行配置和调整。
相关推荐

















