오픈 소스 Electron 애플리케이션 GitHub Actions 자동화 배포 및 업그레이드 가이드

1. 소개

이 문서는 GitHub Actions를 사용하여 Electron 애플리케이션의 자동화 빌드, 출시 및 UpgradeLink를 통한 자동 업데이트를 실현하는 방법에 대한 자세한 가이드를 제공합니다. 이 가이드를 통해 코드 제출에서 애플리케이션 업데이트까지의 전체 자동화 프로세스를 완료하기 위해 GitHub Actions 워크플로를 구성하는 방법을 배울 수 있습니다.

2. 핵심 도구 소개

1. UpgradeLink GitHub Action

UpgradeLink는 Electron 애플리케이션에서 생성된 업데이트 파일을 UpgradeLink 서버에 업로드하기 위한 GitHub Action 플러그인을 제공합니다. UpgradeLink는 JSON 파일에서 애플리케이션 파일 주소를 읽어 파일을 저장하고 자동으로 애플리케이션 버전 파일 및 해당 업그레이드 전략을 생성합니다.

프로젝트 주소

2. 완전한 워크플로를 갖춘 예제 프로젝트

완전한 워크플로를 갖춘 예제 프로젝트:

예제 프로젝트 electron-demo

3. 워크플로 설명

워크플로는 세 가지 주요 작업으로 구성됩니다:

electron-build: 다른 플랫폼 및 아키텍처용 Electron 애플리케이션 패키지를 빌드 및 출시합니다.
- 크로스 플랫폼 빌드: macOS, Linux 및 Windows를 동시에 지원합니다.
- 버전 추출: Electron 빌드 출력에서 애플리케이션 버전 번호를 추출합니다.
electron-release: electron-build에 의해 빌드된 패키지에 기반하여 버전을 출시합니다.
- 릴리스 관리: 자동으로 GitHub Release를 생성하고 애플리케이션 설치 패키지를 업로드합니다.
- 출력 매개변수: 후속 작업을 위해 애플리케이션 버전 번호를 출력합니다.
upgradeLink-upload: 업데이트 정보를 UpgradeLink에 동기화합니다.
- 종속성: 위의 두 작업이 완료될 때까지 기다립니다.
- 버전 인식: 출력 매개변수를 통해 애플리케이션 버전 번호를 얻습니다.
- API 호출: UpgradeLink Action을 사용하여 해당 설치 패키지를 업그레이드 서버에 업로드합니다.

4. 통합 단계 자세한 설명

1. 준비

먼저 다음을 확인하세요:

GitHub 리포지토리가 생성되었고 Electron 애플리케이션 코드가 업로드되었습니다.
UpgradeLink 플랫폼 계정이 있으며 다음 자격 증명을 얻었습니다:
- ACCESS_KEY (Access Key) 키 정보
- ELECTRON_KEY (애플리케이션 고유 식별자) 애플리케이션 정보
UpgradeLink 플랫폼의 electron 애플리케이션 구성에 GitHub 리포지토리 주소를 구성했습니다.

2. GitHub Secrets 구성

GitHub 리포지토리 Settings > Security > Secrets and variables > Actions에서 다음 암호화된 환경 변수를 추가하세요:

Secret Name	Description
UPGRADE_LINK_ACCESS_KEY	API 호출 인증을 위해 UpgradeLink 플랫폼에서 제공하는 액세스 키
UPGRADE_LINK_ELECTRON_KEY	UpgradeLink 플랫폼에서 귀하의 Electron 애플리케이션에 할당된 고유 식별자

3. electron-demo/.github/workflows/main.yml GitHub Action 파일을 편집하고 필요에 따라 조정하세요.

yaml

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
          - platform: ubuntu-22.04
            target: x86_64-unknown-linux-gnu
            artifact-name: ubuntu-x86_64
            arch-suffix: x64
            # Directly define complete build command including channel information
            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
          - 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
          - 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
        # Directly execute the complete build command defined in the matrix
        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

          # Process duplicate platform identifiers first
          for file in *.yml; do
            if [ -f "$file" ]; then
              # Fixed replacement -linux-linux to -linux
              if [[ "$file" == *-linux-linux* ]]; then
                new_file="${file//-linux-linux/-linux}"
                mv "$file" "$new_file"
                echo "替换重复标识: $file -> $new_file"
                file="$new_file"
              fi

              # Fixed replacement -mac-mac to -mac
              if [[ "$file" == *-mac-mac* ]]; then
                new_file="${file//-mac-mac/-mac}"
                mv "$file" "$new_file"
                echo "替换重复标识: $file -> $new_file"
                file="$new_file"
              fi
          
              # Fixed replacement x86_64-x64 to -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

              # Process architecture suffix
              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: |
          # Prioritize getting version number from tag
          if [[ "${{ github.ref }}" == refs/tags/* ]]; then
            VERSION=${{ github.ref_name }}
          else
            # If not a tag push, read version number from package.json
            VERSION=$(node -p "require('./package.json').version")
            # Or use a fixed default value
            # 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 모듈을 도입합니다. 해당 정보를 교체하세요

yaml

  upgradeLink-upload:
     # Depend on both electron-build and electron-release to ensure access to electron-build output
     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 application unique identifier
           github-token: ${{ secrets.GITHUB_TOKEN }}
           version: ${{ needs.electron-build.outputs.appVersion }}
           prompt-upgrade-content: 'Upgrade prompt content'

5. 일반적인 문제 및 해결 방법

1. 서명 문제

macOS 자동 업데이트를 작동시키려면 애플리케이션에 서명해야 합니다. 참조 문서

2. 빌드 실패 문제 해결

GitHub Actions 로그에서 특정 오류 정보를 확인하세요
모든 종속성이 올바르게 설치되었는지 확인하세요, 특히 Linux 플랫폼의 시스템 종속성
Node.js 버전 호환성을 확인하세요

3. UpgradeLink 통합 문제

UpgradeLink 콘솔의 애플리케이션 식별자가 구성과 일치하는지 확인하세요
GitHub Releases에 올바른 설치 패키지 파일이 생성되었는지 확인하세요

6. 요약

위의 구성을 통해 Electron 애플리케이션 빌드, 출시 및 업데이트 프로세스의 전체 자동화를 실현할 수 있습니다. 코드가 지정된 브랜치에 푸시될 때마다 GitHub Actions는 자동으로 다음 작업을 완료합니다:

코드 변경 감지
다중 플랫폼 환경에서 Electron 애플리케이션 빌드
GitHub Release 생성 및 설치 패키지 업로드
애플리케이션 버전 번호 추출
업데이트 정보를 UpgradeLink 플랫폼에 동기화
최종 사용자는 UpgradeLink를 통해 애플리케이션 업데이트 알림을 받게 됩니다

이 자동화된 워크플로는 개발 효율성을 크게 향상시키고 수동 작업 오류를 줄이며 개발자가 애플리케이션 기능 개발에 더 집중할 수 있도록 합니다.

URL 애플리케이션

파일 애플리케이션

구성

Tauri 애플리케이션

Electron 애플리케이션

Android 애플리케이션

Windows 애플리케이션

Linux 애플리케이션

macOS 애플리케이션

애플리케이션 정보 보고

URL 애플리케이션

파일 애플리케이션

구성

Tauri 애플리케이션

Electron 애플리케이션

Android 애플리케이션

Windows 애플리케이션

Linux 애플리케이션

macOS 애플리케이션

애플리케이션 정보 보고

URL 애플리케이션

파일 애플리케이션

구성

Tauri 애플리케이션

Electron 애플리케이션

Android 애플리케이션

Windows 애플리케이션

Linux 애플리케이션

macOS 애플리케이션

애플리케이션 정보 보고

URL 애플리케이션

파일 애플리케이션

구성

Tauri 애플리케이션

Electron 애플리케이션

Android 애플리케이션

Windows 애플리케이션

Linux 애플리케이션

macOS 애플리케이션

애플리케이션 정보 보고

URL 애플리케이션

파일 애플리케이션

URL 애플리케이션

파일 애플리케이션

Android 애플리케이션

구성 업그레이드

URL 애플리케이션

파일 애플리케이션

Windows 애플리케이션

구성 업그레이드

오픈 소스 Electron 애플리케이션 GitHub Actions 자동화 배포 및 업그레이드 가이드 ​

1. 소개 ​

2. 핵심 도구 소개 ​

1. UpgradeLink GitHub Action ​

2. 완전한 워크플로를 갖춘 예제 프로젝트 ​

3. 워크플로 설명 ​

4. 통합 단계 자세한 설명 ​

1. 준비 ​

2. GitHub Secrets 구성 ​

3. electron-demo/.github/workflows/main.yml GitHub Action 파일을 편집하고 필요에 따라 조정하세요. ​

4. upgradelink-action 모듈을 도입합니다. 해당 정보를 교체하세요 ​

5. 일반적인 문제 및 해결 방법 ​

1. 서명 문제 ​

2. 빌드 실패 문제 해결 ​

3. UpgradeLink 통합 문제 ​

6. 요약 ​

오픈 소스 Electron 애플리케이션 GitHub Actions 자동화 배포 및 업그레이드 가이드

1. 소개

2. 핵심 도구 소개

1. UpgradeLink GitHub Action

2. 완전한 워크플로를 갖춘 예제 프로젝트

3. 워크플로 설명

4. 통합 단계 자세한 설명

1. 준비

2. GitHub Secrets 구성

3. electron-demo/.github/workflows/main.yml GitHub Action 파일을 편집하고 필요에 따라 조정하세요.

4. upgradelink-action 모듈을 도입합니다. 해당 정보를 교체하세요

5. 일반적인 문제 및 해결 방법

1. 서명 문제

2. 빌드 실패 문제 해결

3. UpgradeLink 통합 문제

6. 요약