✨ add electron-updater

Author: xuxiaowei-com-cn

.github/workflows/node.js.yml

@@ -31,24 +31,7 @@ jobs:
       - name: Create package-lock.json
         shell: sh
         run: |
-          cat << EOF > package-lock.json
-          {
-            "name": "electron-vvt",
-            "version": "0.0.1",
-            "lockfileVersion": 3,
-            "requires": true,
-            "packages": {
-              "": {
-                "name": "electron-vvt",
-                "version": "0.0.1",
-                "license": "Apache-2.0",
-                "engines": {
-                  "node": ">=20"
-                }
-              }
-            }
-          }
-          EOF
+          cp package.json package-lock.json
 
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v4

.github/workflows/npm-publish.yml

@@ -0,0 +1,68 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Publish
+
+on:
+  push:
+    # This will trigger on any tag push
+    tags:
+      - '*'
+
+env:
+  GH_TOKEN: ${{ secrets.GH_TOKEN }}
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        node-version: [ 22.x ]
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Create package-lock.json
+        shell: sh
+        run: |
+          cp package.json package-lock.json
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Delete .npmrc
+        shell: sh
+        run: rm -rf .npmrc
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Mac Publish with npm
+        if: ${{ matrix.os == 'macos-latest' }}
+        env:
+          CSC_LINK: ${{ secrets.MAC_CERT_BASE64 }}
+          CSC_KEY_PASSWORD: ${{ secrets.MAC_CERT_PASSWORD }}
+        run: npm run build:publish
+
+      - name: Windows Publish with npm
+        if: ${{ matrix.os == 'windows-latest' }}
+        env:
+          CSC_LINK: ${{ secrets.WINDOWS_CERT_BASE64 }}
+          CSC_KEY_PASSWORD: ${{ secrets.WINDOWS_CERT_PASSWORD }}
+        run: npm run build:publish
+
+      - name: Linux Publish with npm
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+        env:
+          CSC_LINK: ${{ secrets.LINUX_CERT_BASE64 }}
+          CSC_KEY_PASSWORD: ${{ secrets.LINUX_CERT_PASSWORD }}
+        run: npm run build:publish

electron-builder.ts

@@ -28,9 +28,18 @@ export default <Configuration>{
     'main.js',
     // 预加载文件
     'preload.js',
+    // 更新配置文件
+    'updater.js'
   ],
   // 生成资源的目录
   directories: {
     output: 'release/${version}',
   },
+  linux: {
+    target: [
+      {
+        target: 'AppImage',
+      }
+    ]
+  }
 }

main.js

@@ -7,6 +7,8 @@ import log from 'electron-log'
 import Store from 'electron-store'
 import fs from 'fs/promises'
 
+import './updater.js'
+
 const store = new Store()
 
 const __dirname = fileURLToPath(new URL('.', import.meta.url))

package.json

@@ -17,6 +17,7 @@
     "dev": "vite",
     "build-only": "vite build",
     "build": "run-p type-check \"build-only {@}\" -- && electron-builder",
+    "build:publish": "npm run build -- --publish always",
     "preview": "vite preview",
     "test:unit": "vitest",
     "test:e2e": "playwright test",
@@ -35,6 +36,7 @@
     "electron-builder",
     "electron-log",
     "electron-store",
+    "electron-updater",
     "pinia",
     "playwright",
     "typescript",
@@ -45,7 +47,8 @@
   ],
   "dependencies": {
     "electron-log": "5.3.4",
-    "electron-store": "10.0.1"
+    "electron-store": "10.0.1",
+    "electron-updater": "6.6.2"
   },
   "devDependencies": {
     "@playwright/test": "1.52.0",

updater.js

@@ -0,0 +1,38 @@
+import { app } from 'electron'
+import log from 'electron-log'
+import electronUpdater from 'electron-updater'
+
+const logUpdater = log.create({ logId: 'updater' })
+logUpdater.transports.file.fileName = 'updater.log'
+logUpdater.scope.defaultLabel = 'updater'
+logUpdater.scope.labelPadding = 8
+
+const { autoUpdater } = electronUpdater
+
+app.on('ready', function () {
+  logUpdater.info('App is ready')
+
+  // 使用 electron-log 的日志接管 autoUpdater 的日志
+  autoUpdater.logger = logUpdater
+
+  // 强制开发中检查更新（需要在项目根目录中添加 dev-app-update.yml 文件，可参考打包安装后安装目录下的 app-update.yml 并做相应的修改，用于指定开发中检查更新的配置）
+  // autoUpdater.forceDevUpdateConfig = true
+
+  if (autoUpdater.forceDevUpdateConfig !== true) {
+    // 未强制开启检查更新
+
+    if (process.env.NODE_ENV === 'development') {
+      // 开发环境、未强制开启检查更新，则不执行以下代码，直接结束
+      return
+    }
+    if (process.env.NODE_ENV === 'preview') {
+      // 预览环境、未强制开启检查更新，则不执行以下代码，直接结束
+      return
+    }
+  }
+
+  // 检查更新：启动程序后立即执行
+  autoUpdater.checkForUpdates().then((updateCheckResult) => {
+    logUpdater.info('UpdateCheckResult.updateInfo:\n', updateCheckResult.updateInfo)
+  })
+})