当前位置： 首页 > news >正文

开源Electron应用GitHubActions自动化部署与升级指南

news 2026/7/9 4:45:23

开源 Electron 应用 GitHub Actions 自动化部署与升级指南

一、前言

本文详细介绍如何利用 GitHub Actions 实现 Electron 应用的自动化构建、发布及通过 UpgradeLink 实现应用自动更新功能。通过本指南，你将学会配置
GitHub Actions 工作流，完成从代码提交到应用更新的全自动化流程。

二、核心工具介绍

1. UpgradeLink GitHub Action

UpgradeLink 提供的 GitHub Action 插件，用于将 Electron 应用生成的更新文件上传至 UpgradeLink 服务器，
UpgradeLink 读取json文件中应用文件的地址，保存文件，自动实现应用版本文件的创建，和对应升级策略的创建。

  • 项目地址

2.已经跑完全部流程的示例项目

流程的示例项目

  • 示例项目 electron-demo

三、工作流说明

工作流分为三个主要作业：

  1. electron-build：构建并发布 Electron 应用打包不同端与架构的安装包

    • 跨平台构建：同时支持 macOS、Linux 和 Windows
    • 版本号提取：从 Electron 构建输出中提取应用版本号

  2. electron-release：根据electron-build构建输出的包，进行 Releases 版本发布

    • 发布管理：自动创建 GitHub Release 并上传应用安装包
    • 输出参数：输出应用版本号，用于后续作业

  3. upgradeLink-upload：将更新信息同步到 UpgradeLink

    • 依赖关系：等待 上面两个作业 作业完成
    • 版本感知：通过输出参数获取应用版本号
    • API 调用：使用 UpgradeLink Action 将对应的安装包上传至升级服务器

四、接入步骤详解

1. 前期准备

首先需要确保：

  • 已创建 GitHub 仓库并上传 Electron 应用代码
  • 拥有 UpgradeLink 平台的账号并获取以下凭证：
    • ACCESS_KEY（访问密钥） 密钥信息
    • ELECTRON_KEY（应用唯一标识） 应用信息
  • 在 UpgradeLink平台的 electron 应用配置中，配置上 github 仓库的地址。

2. 配置 GitHub Secrets

在 GitHub 仓库的 Settings > Security > Secrets and variables > Actions 中添加以下加密环境变量：

Secret 名称说明
UPGRADE_LINK_ACCESS_KEYUpgradeLink 平台提供的访问密钥，用于 API 调用身份验证
UPGRADE_LINK_ELECTRON_KEYUpgradeLink 平台为你的 Electron 应用分配的唯一标识

3. 编辑 electron-demo/.github/workflows/main.yml github-Action文件，根据自己的需要，进行调整。

name: 'publish' on: push: branches: - main tags: - '*.*.*' jobs: electron-build: outputs: appVersion: ${{ steps.extract-version.outputs.appVersion }} permissions: contents: write strategy: fail-fast: false matrix: include: # Linux 平台 - platform: ubuntu-22.04 target: x86_64-unknown-linux-gnu artifact-name: ubuntu-x86_64 arch-suffix: x64 # 直接定义完整的构建命令，包含通道信息 build-command: "yarn electron-builder --linux --x64 --publish always --config.publish.channel=latest-linux" - platform: ubuntu-22.04 target: aarch64-unknown-linux-gnu artifact-name: ubuntu-aarch64 arch-suffix: arm64 build-command: "yarn electron-builder --linux --arm64 --publish always --config.publish.channel=latest-linux" # macOS 平台 - platform: macos-latest target: aarch64-apple-darwin artifact-name: macos-arm64 arch-suffix: arm64 build-command: "yarn electron-builder --mac --arm64 --publish always --config.publish.channel=latest-mac" - platform: macos-latest target: x86_64-apple-darwin artifact-name: macos-x64 arch-suffix: x64 build-command: "yarn electron-builder --mac --x64 --publish always --config.publish.channel=latest-mac" # Windows 平台 - platform: windows-latest target: x86_64-pc-windows-msvc artifact-name: windows-x64 arch-suffix: x64 build-command: "yarn electron-builder --win --x64 --publish always --config.publish.channel=latest-win" runs-on: ${{ matrix.platform }} steps: - uses: actions/checkout@v4 - name: setup node uses: actions/setup-node@v4 with: node-version: lts/* cache: 'yarn' - name: Install dependencies with yarn run: yarn install - name: List installed dependencies run: yarn list - name: install dependencies (ubuntu only) if: startsWith(matrix.platform, 'ubuntu') run: | sudo apt-get update sudo apt-get install -y libwebkit2gtk-4.1-dev libappindicator3-dev librsvg2-dev patchelf xdg-utils - name: install dependencies (macos only) if: matrix.platform == 'macos-latest' run: | brew install automake autoconf libtool - name: install frontend dependencies run: yarn install - name: Install rimraf run: yarn add rimraf --dev - name: Build Electron App # 直接执行矩阵中定义的完整构建命令 run: ${{ matrix.build-command }} env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - name: Cleanup Artifacts for Linux if: startsWith(matrix.platform, 'ubuntu') run: | mkdir -p dist-temp find dist -maxdepth 1 -type f \( -name "*.AppImage" -o -name "*.yml" -o -name "*.zip" \) -exec cp {} dist-temp/ \; rm -rf dist mv dist-temp dist echo "保留的发布文件：" ls -la dist - name: Cleanup Artifacts for macOS if: matrix.platform == 'macos-latest' run: | mkdir -p dist-temp find dist -maxdepth 1 -type f \( -name "*.dmg" -o -name "*.pkg" -o -name "*.zip" -o -name "*.yml" \) -exec cp {} dist-temp/ \; rm -rf dist mv dist-temp dist echo "保留的发布文件：" ls -la dist - name: Cleanup Artifacts for Windows if: matrix.platform == 'windows-latest' run: | New-Item -ItemType Directory -Path dist-temp -Force | Out-Null Get-ChildItem -Path dist -File | Where-Object { $_.Name -like "*.exe" -or $_.Name -like "*.msi" -or $_.Name -like "*.zip" -or $_.Name -like "*.yml" } | Copy-Item -Destination dist-temp/ Remove-Item -Path dist -Recurse -Force Rename-Item -Path dist-temp -NewName dist Write-Host "保留的发布文件：" Get-ChildItem -Path dist - name: Rename files with architecture suffix (Linux/macOS) if: startsWith(matrix.platform, 'ubuntu') || matrix.platform == 'macos-latest' run: | cd dist ARCH_SUFFIX="${{ matrix.arch-suffix }}" if [ "$ARCH_SUFFIX" != "x64" ] && [ "$ARCH_SUFFIX" != "arm64" ]; then echo "错误: 架构后缀不正确 - $ARCH_SUFFIX" exit 1 fi # 先处理重复平台标识 for file in *.yml; do if [ -f "$file" ]; then # 固定替换 -linux-linux 为 -linux if [[ "$file" == *-linux-linux* ]]; then new_file="${file//-linux-linux/-linux}" mv "$file" "$new_file" echo "替换重复标识: $file -> $new_file" file="$new_file" fi # 固定替换 -mac-mac 为 -mac if [[ "$file" == *-mac-mac* ]]; then new_file="${file//-mac-mac/-mac}" mv "$file" "$new_file" echo "替换重复标识: $file -> $new_file" file="$new_file" fi # 固定替换 x86_64-x64 为 -x64 if [[ "$file" == *-x86_64-x64* ]]; then new_file="${file//x86_64-x64/-x64}" mv "$file" "$new_file" echo "替换重复标识: $file -> $new_file" file="$new_file" fi # 处理架构后缀 if [[ "$file" != *-"$ARCH_SUFFIX".* ]]; then filename="${file%.*}" extension="${file#$filename}" new_filename="${filename}-${ARCH_SUFFIX}${extension}" mv "$file" "$new_filename" echo "添加架构后缀: $file -> $new_filename" else echo "文件已处理完成: $file" fi fi done echo "最终文件列表:" ls -l - name: Rename files with architecture suffix (Windows) if: matrix.platform == 'windows-latest' run: | cd dist $ARCH_SUFFIX = "${{ matrix.arch-suffix }}" if ($ARCH_SUFFIX -ne "x64" -and $ARCH_SUFFIX -ne "arm64") { Write-Error "错误: 架构后缀不正确 - $ARCH_SUFFIX" exit 1 } Get-ChildItem -File | ForEach-Object { $file = $_ if ($file.Name -match "-$ARCH_SUFFIX\.[^.]+$") { Write-Host "文件已包含架构后缀: $($file.Name)" } else { $filename = $file.BaseName $extension = $file.Extension $new_filename = "$filename-$ARCH_SUFFIX$extension" Rename-Item -Path $file.FullName -NewName $new_filename Write-Host "重命名: $($file.Name) -> $new_filename" } } Write-Host "重命名后的文件:" Get-ChildItem -File - name: Extract version id: extract-version run: | # 优先从标签获取版本号 if [[ "${{ github.ref }}" == refs/tags/* ]]; then VERSION=${{ github.ref_name }} else # 如果不是标签推送，从package.json读取版本号 VERSION=$(node -p "require('./package.json').version") # 或者使用固定的默认值 # VERSION="dev-$(date +%Y%m%d)" fi echo "appVersion=$VERSION" >> $GITHUB_OUTPUT echo "Extracted version: $VERSION" shell: bash - name: Upload artifacts uses: actions/upload-artifact@v4.0.0 with: name: ${{ matrix.artifact-name }} path: dist/* if-no-files-found: error electron-release: needs: electron-build runs-on: ubuntu-22.04 permissions: contents: write steps: - name: Download all artifacts uses: actions/download-artifact@v4 with: path: artifacts merge-multiple: false - name: Verify artifact files run: | echo "下载的文件结构:" tree artifacts if [ -z "$(find artifacts -type f)" ]; then echo "错误: 没有找到任何artifact文件" exit 1 fi - name: Prepare release files run: | mkdir -p release-files find artifacts -type f -exec cp {} release-files/ \; echo "准备发布的文件:" ls -l release-files - name: Create GitHub Release uses: softprops/action-gh-release@v1 with: tag_name: ${{ needs.electron-build.outputs.appVersion }} name: Release ${{ needs.electron-build.outputs.appVersion }} files: release-files/* draft: false prerelease: false env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4. 引入 upgradelink-action模块。替换对应的信息
upgradeLink-upload: # 同时依赖 electron-build 和 electron-release，确保能访问 electron-build 的输出 needs: [ electron-build, electron-release ] permissions: contents: write runs-on: ubuntu-latest steps: - name: Send a request to UpgradeLink uses: toolsetlink/upgradelink-action-electron@v1.0.1 with: source-url: 'https://github.com/toolsetlink/electron-demo/releases/download/${{ needs.electron-build.outputs.appVersion }}' access-key: ${{ secrets.UPGRADE_LINK_ACCESS_KEY }} # ACCESS_KEY 密钥key electron-key: ${{ secrets.UPGRADE_LINK_ELECTRON_KEY }} # ELECTRON_KEY electron 应用唯一标识 github-token: ${{ secrets.GITHUB_TOKEN }} version: ${{ needs.electron-build.outputs.appVersion }} prompt-upgrade-content: '提示升级内容'

五、常见问题与解决方案

1. 签名问题

  • macOS
    应用程序必须签名才能使自动更新工作。 参考文档

2. 构建失败排查

  • 检查 GitHub Actions 日志，查看具体错误信息
  • 确认所有依赖已正确安装，特别是 Linux 平台的系统依赖
  • 确保 Node.js 版本兼容

3. UpgradeLink 集成问题

  • 检查 UpgradeLink 控制台中的应用标识是否与配置一致
  • 确认 GitHub Releases 中是否生成了正确的 安装包 文件

六、总结

通过以上配置，你可以实现 Electron 应用的全自动化构建、发布和更新流程。每当代码推送到指定分支时，GitHub Actions 将自动完成以下工作：

  1. 检测代码变更
  2. 在多平台环境中构建 Electron 应用
  3. 创建 GitHub Release 并上传安装包
  4. 提取应用版本号
  5. 将更新信息同步到 UpgradeLink 平台
  6. 最终用户将通过 UpgradeLink 收到应用更新通知

这种自动化流程大大提高了开发效率，减少了手动操作错误，让开发者可以更专注于应用功能开发。

http://www.cnnetsun.cn/news/11160.html

相关文章：

  • VSCode调试量子神经网络的7个致命陷阱，第5个连资深工程师都中招
  • 9 个课堂汇报 AI 工具，本科生高效写作推荐
  • Wan2.2-T2V-A14B能否生成机场航班信息指引动画？公共信息服务升级
  • Wan2.2-T2V-A14B模型全面解读：从架构到应用场景
  • Bili2text：智能解析B站视频内容的文字转换利器
  • JVM深度调优：深入 G1、ZGC 等新型垃圾回收器的适用场景与调优参数
  • 博士生应该在大论文下功夫还是小论文？ 虎贲等考AI智能写作：https://www.aihbdk.com/
  • Qwen3-VL-4B-Instruct-FP8震撼发布：多模态大模型技术突破引领行业新范式
  • 基于微信小程序的电影票预订系统毕业设计源码
  • 37、分布式网络文件系统全解析
  • AKM31C-ACSNLB0 伺服电机
  • E94ASHE0044伺服驱动器
  • Windows右键菜单终极清理指南：ContextMenuManager让你的电脑焕然一新
  • 通义千问凭借“门控注意力”斩获 NeurIPS 最佳论文奖！详解Gated Attention原理
  • 11、MobX实战应用与特殊API解析
  • 从加密到解析仅需2分钟：Dify自动化PDF处理黑科技曝光
  • 申请TELEC认证需要准备哪些材料？
  • 大模型微调技术全解析：程序员必备收藏指南
  • ABB AF460-30-11 空气断路器
  • 利用cubemx和HAL库重写江科协的oled驱动程序
  • LAMMPS分子动力学模拟技术与应用
  • 深度学习中 z-score 标准化理解
  • 硬件测试面试题 - 模拟面试|AI面试官
  • QCoreApplication::aboutToQuit 可以链接多个槽函数吗
  • VLAN实验
  • Wan2.2-T2V-A14B模型对不同肤色人种的表现公平性评估
  • CTF竞赛系统、知识竞赛系统、漏洞靶场练习系统
  • 云主机Agent权限失控？AZ-500安全专家教你3招紧急封堵
  • HBase vs. 传统数据库：大数据时代的存储革命
  • Flutter 从原理到实战：深入理解跨平台框架核心与高效开发实践