Electron Builder GitHub Action 使用教程

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 Action。项目的主要目录结构如下：

• .github/: 存放 GitHub Actions 工作流文件。
  • workflows/: 包含工作流配置文件，例如 build.yml。
• LICENSE.md: 项目的 MIT 许可证文件。
• README.md: 项目的自述文件，介绍项目的使用方法。
• action.yml: GitHub Action 的配置文件，定义了输入变量和 Action 的行为。
• index.js: Action 的主要执行脚本。
• package.json: 项目依赖和脚本定义。
• yarn.lock: 依赖锁文件，确保在不同环境中安装相同的依赖版本。

2. 项目的启动文件介绍

index.js 是 Electron Builder GitHub Action 的启动文件。它负责接收 GitHub Actions 的工作流输入，执行 Electron 应用的构建和发布流程。

启动文件的主要功能包括：

• 检查和读取输入变量，如 package_root、build_script_name 等。
• 执行 Node.js 脚本，如 yarn install 和预定义的构建脚本。
• 运行 electron-builder 命令来构建应用。
• 根据是否设置了标签，决定是否发布应用到 GitHub Releases。

3. 项目的配置文件介绍

action.yml 是 Electron Builder GitHub Action 的配置文件，它定义了以下内容：

• 输入变量：用户可以自定义的变量，如构建脚本名称、是否跳过构建等。
• 步骤：定义了 Action 执行的步骤，包括检查 Git 仓库、安装 Node.js 和 Yarn、构建和发布 Electron 应用。

配置文件中常见的输入变量包括：

• package_root: 指定 NPM/Yarn 命令应该运行的目录。
• build_script_name: 定义运行构建的脚本名称。
• skip_build: 指定是否跳过运行构建脚本。
• use_vue_cli: 是否使用 Vue CLI 插件来运行 electron-builder。
• args: 传递给 electron-builder 命令的其他参数。
• max_attempts: 完成构建和发布步骤的最大尝试次数。

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