Skip to content

Electron Project Integration Reference Using Official electron-builder Component

1. Introduction to Official electron-builder Component

The official electron-builder component provided by Electron includes core features:

  • Cross-platform installation package generation
  • Support for multiple installation package formats (such as dmg, exe, deb, rpm, etc.)

Core Resources

2. Integration Core Steps

Reference electron-demo project address

1. Install Official Update Component

2. Modify package.json File, Add Packaging Configuration Items

json
    "build": {
        "appId": "com.example.electron-updater-demo",
        "productName": "electron-demo",
        "publish": {
          "provider": "generic",
          "url": "./dist/"
        },
        "mac": {
          "category": "public.app-category.developer-tools",
          "artifactName": "${productName}-${version}-mac-${arch}.${ext}"
        },
        "linux": {
          "target": [
            "AppImage"
          ],
          "category": "Utility",
          "artifactName": "${productName}-${version}-linux-${arch}.${ext}"
        },
        "win": {
          "target": [
            "nsis"
          ],
          "icon": "build/icon.ico",
          "artifactName": "${productName}-${version}-win-${arch}.${ext}"
        }
    },

3. Add Packaging Commands, Add Packaging Configuration Items, Configure Packaging Commands for Different Platforms

json
    "scripts": {
        "build:mac-arm64": "yarn electron-builder --mac --arm64 --publish always --config.publish.channel=latest-arm64",
        "build:mac-x64": "yarn electron-builder --mac --x64 --publish always --config.publish.channel=latest-x64",
        "build:win-x64": "yarn electron-builder --win --x64 --publish always --config.publish.channel=latest-win-x64",
        "build:linux-arm64": "yarn electron-builder --linux --arm64 --publish always --config.publish.channel=latest-linux-arm64",
        "build:linux-x64": "yarn electron-builder --linux --x64 --publish always --config.publish.channel=latest-linux-x64",
    },

4. Execute Corresponding Packaging Commands to Generate Installation Packages

  • Execute build:mac-arm64 to generate mac arm64 installation package
  • Execute build:mac-x64 to generate mac x64 installation package
  • Execute build:win-x64 to generate win x64 installation package
  • Execute build:linux-arm64 to generate linux arm64 installation package
  • Execute build:linux-x64 to generate linux x64 installation package

The above is the integration guide. If you need to adjust content details or supplement specific scenario descriptions, please inform specific requirements.

toolsetlink@163.com