Electron Builder GitHub Action 使用指南

最新推荐文章于 2025-05-21 11:31:27 发布

徐霞千Ruth

最新推荐文章于 2025-05-21 11:31:27 发布

阅读量779

点赞数 12

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00589/article/details/146973334

Electron Builder GitHub Action 使用指南

action-electron-builder :electron: GitHub Action for building and releasing Electron apps 项目地址: https://gitcode.com/gh_mirrors/ac/action-electron-builder

1. 项目介绍

Electron Builder GitHub Action 是一个开源项目，旨在帮助开发者自动化构建和发布 Electron 应用程序。通过集成 GitHub 的 CI/CD 能力，该项目可以自动执行代码的打包和发布流程，支持 macOS、Windows 和 Linux 操作系统。

2. 项目快速启动

以下是一个快速启动 Electron Builder GitHub Action 的示例：

# .github/workflows/build.yml

name: Build/release

on:
  push:

jobs:
  release:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [macos-latest, ubuntu-latest, windows-latest]

    steps:
    - name: Check out Git repository
      uses: actions/checkout@v1

    - name: Install Node.js, NPM and Yarn
      uses: actions/setup-node@v1
      with:
        node-version: '14'

    - name: Build/release Electron app
      uses: samuelmeuli/action-electron-builder@v1
      with:
        github_token: ${{ secrets.github_token }}
        release: ${{ startsWith(github.ref, 'refs/tags/v') }}

确保你的项目已经配置好 electron-builder 并且在 package.json 中有一个 build 脚本。以上工作流会在每次推送时自动构建你的应用程序，并且如果提交包含一个版本号标签（例如 v1.0.0），它将发布一个新的版本。

3. 应用案例和最佳实践

案例一：自动发布新版本

当你需要发布一个新版本时，更新 package.json 中的版本号，然后创建一个对应的 Git 标签并推送。例如：

git commit -am "v1.2.3"
git tag v1.2.3
git push && git push --tags

案例二：配置代码签名和公证

对于 macOS 应用程序，你可能需要配置代码签名和公证。首先，导出你的证书并将其编码为 Base64，然后在 GitHub 仓库的设置中添加相应的密钥。

base64 -i certs.p12 -o encoded.txt

在 GitHub 仓库的 Secrets 中添加 mac_certs 和 mac_certs_password。

然后，在你的工作流中添加以下步骤：

- name: Build/release Electron app
  uses: samuelmeuli/action-electron-builder@v1
  with:
    mac_certs: ${{ secrets.mac_certs }}
    mac_certs_password: ${{ secrets.mac_certs_password }}