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 的 CI/CD 功能。这个 Action 能够帮助开发者打包 Electron 应用，并自动发布到 GitHub Releases 或其他平台。

项目主要使用的编程语言是 JavaScript。

2. 关键技术和框架

该项目使用以下关键技术：

• GitHub Actions: GitHub 提供的持续集成和持续部署服务。
• Electron Builder: 一个用于打包 Electron 应用的工具。
• Node.js: 执行 JavaScript 代码的服务器端运行环境。

3. 准备工作和安装步骤

准备工作

在开始之前，请确保您已经具备以下条件：

• 一个 GitHub 帐户。
• 基本的 Git 和 GitHub 知识。
• 已安装 Node.js 和 npm。

安装步骤

步骤 1: 创建一个新的 GitHub 仓库

1. 访问 GitHub 并创建一个新的仓库。
2. 克隆仓库到本地环境。

git clone https://github.com/yourusername/your-repo.git
cd your-repo

步骤 2: 初始化 Node.js 项目

在项目根目录下执行以下命令：

npm init -y

步骤 3: 安装 Electron 和 Electron Builder

安装 Electron 和 Electron Builder 到项目中：

npm install electron electron-builder --save-dev

步骤 4: 配置 Electron Builder

在项目根目录下创建一个 package.json 文件，并添加以下内容：

"scripts": {
  "build": "electron-builder --dir"
}

步骤 5: 创建 GitHub Actions 工作流文件

在项目根目录下创建一个 .github/workflows 文件夹，并在该文件夹中创建一个 build.yml 文件。添加以下内容：

name: Build and Release

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository
        uses: actions/checkout@v1

      - name: Set up Node.js
        uses: actions/setup-node@v1
        with:
          node-version: '14'

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

步骤 6: 添加版本号和标签

在 package.json 文件中设置版本号，并在本地创建一个与版本号匹配的 Git 标签：

npm version 1.0.0
git tag v1.0.0

步骤 7: 推送更改到 GitHub

推送您的更改和标签到 GitHub 仓库：

git push --all

现在，每次您推送一个带有新版本号的标签时，GitHub Actions 都会自动构建和发布您的 Electron 应用。

以上就是 Electron Builder GitHub Action 的详细安装和配置指南。按照这些步骤操作，您应该能够成功设置自动构建和发布您的 Electron 应用。

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