macOS用アプリケーションとdmgファイル、zipファイルの自動ビルド

.github/workflows/build.yml

@@ -28,6 +28,7 @@ jobs:
           - linux-noengine-cpu-prepackage
           - windows-noengine-prepackage
           - windows-noengine-cpu-prepackage
+          - macos-noengine-cpu-prepackage
         include:
           # Linux NVIDIA GPU
           - artifact_name: linux-noengine-prepackage
@@ -55,20 +56,50 @@ jobs:
             package_name: voicevox-cpu
             nsis_web_artifact_name: 'VOICEVOX-CPU Web Setup ${version}.${ext}'
             os: windows-2019
+          # macOS CPU
+          - artifact_name: macos-noengine-cpu-prepackage
+            artifact_path: dist_electron/mac
+            package_name: voicevox-cpu
+            macos_artifact_name: 'VOICEVOX.${ext}'
+            os: macos-11
 
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@master
 
       # Rename executable file
-      - name: Replace package name
+      - name: Replace package name (for Windows and Ubuntu)
+        if: startsWith(matrix.os, 'windows-') || startsWith(matrix.os, 'ubuntu-')
         shell: bash
         run: |
           # GPU: "name": "voicevox" => "name": "voicevox"
           # CPU: "name": "voicevox" => "name": "voicevox-cpu"
           sed -i 's/"name": "voicevox"/"name": "${{ matrix.package_name }}"/' package.json
           # sed -i 's/productName: "VOICEVOX"/productName: "${{ matrix.product_name }}"/' vue.config.js
 
+      # Rename executable file
+      # NOTE: The sed command of macOS is BSD sed,
+      #       so you cannot omit the backup extension after the -i option.
+      - name: Replace package name (for macOS)
+        if: startsWith(matrix.os, 'macos-')
+        shell: bash
+        run: |
+          # GPU: "name": "voicevox" => "name": "voicevox"
+          # CPU: "name": "voicevox" => "name": "voicevox-cpu"
+          sed -i '' 's/"name": "voicevox"/"name": "${{ matrix.package_name }}"/' package.json
+          # sed -i '' 's/productName: "VOICEVOX"/productName: "${{ matrix.product_name }}"/' vue.config.js
+
+      - name: Replace the extraFiles setting in vue.config.js for macOS
+        if: startsWith(matrix.os, 'macos-')
+        shell: bash
+        run: |
+          sed -i '' 's|from: "build/README.txt", to: "README.txt"|from: "build/README.txt", to: "MacOS/README.txt"|' vue.config.js
+          sed -i '' 's|from: ".env.production", to: ".env"|from: ".env.production", to: "MacOS/.env"|' vue.config.js
+          str_config=$(cat vue.config.js)
+          str_config_2=${str_config//$'\n'/\\\\n}
+          echo $str_config_2 | sed -e 's|from: VOICEVOX_ENGINE_DIR,\\\\n[ ]*to: ""|from: VOICEVOX_ENGINE_DIR, to: "MacOS/"|' -e s/'\\\\n'/\\$'\n'/g > vue.config.js
+          cat vue.config.js
+
       - name: Set output Node version
         id: node-version
         shell: bash
@@ -112,8 +143,8 @@ jobs:
         run: |
           df -h
 
-      - name: Overwrite .env.production for Linux
-        if: startsWith(matrix.os, 'ubuntu-')
+      - name: Overwrite .env.production for Linux and macOS
+        if: startsWith(matrix.os, 'ubuntu-') || startsWith(matrix.os, 'macos-')
         shell: bash
         run: |
           echo "ENGINE_PATH=./run" > .env.production
@@ -186,6 +217,7 @@ jobs:
           NSIS_WEB_ARTIFACT_NAME: ${{ matrix.nsis_web_artifact_name }}
           LINUX_ARTIFACT_NAME: ${{ matrix.linux_artifact_name }}
           LINUX_EXECUTABLE_NAME: ${{ matrix.linux_executable_name }}
+          MACOS_ARTIFACT_NAME: ${{ matrix.macos_artifact_name }}
         run: npm run electron:build_pnever -- --dir
 
       - name: Upload NoEngine Prepackage
@@ -215,6 +247,7 @@ jobs:
           - linux-cpu-prepackage
           - windows-nvidia-prepackage
           - windows-cpu-prepackage
+          - macos-cpu-prepackage
         include:
           # Linux NVIDIA GPU
           - artifact_name: linux-nvidia-prepackage
@@ -236,6 +269,11 @@ jobs:
           - artifact_name: windows-cpu-prepackage
             noengine_artifact_name: windows-noengine-cpu-prepackage
             voicevox_engine_asset_name: windows-cpu
+          # macOS CPU
+          - artifact_name: macos-cpu-prepackage
+            noengine_artifact_name: macos-noengine-cpu-prepackage
+            macos_executable_name: VOICEVOX
+            voicevox_engine_asset_name: macos-x64
 
     runs-on: ${{ matrix.os }}
     steps:
@@ -323,6 +361,7 @@ jobs:
           rm -rf voicevox_engine/download voicevox_engine/tmp
 
       - name: Merge licenses.json (ENGINE, VOICEVOX)
+        if: startsWith(matrix.artifact_name, 'windows-') || startsWith(matrix.artifact_name, 'linux-')
         shell: bash
         run: |
           # Unpack asar
@@ -336,12 +375,35 @@ jobs:
           asar pack prepackage/resources/app prepackage/resources/app.asar
           rm -rf prepackage/resources/app
 
+      - name: Merge licenses.json (ENGINE, VOICEVOX) (macOS)
+        if: startsWith(matrix.artifact_name, 'macos-')
+        shell: bash
+        run: |
+          # Unpack asar
+          asar extract prepackage/VOICEVOX.app/Contents/Resources/app.asar prepackage/VOICEVOX.app/Contents/Resources/app
+          rm prepackage/VOICEVOX.app/Contents/Resources/app.asar
+
+          mv voicevox_engine/voicevox_engine/licenses.json engine_licenses.json
+          npm run license:merge -- -o prepackage/VOICEVOX.app/Contents/Resources/app/licenses.json -i engine_licenses.json -i prepackage/VOICEVOX.app/Contents/Resources/app/licenses.json
+
+          # Repack asar
+          asar pack prepackage/VOICEVOX.app/Contents/Resources/app prepackage/VOICEVOX.app/Contents/Resources/app.asar
+          rm -rf prepackage/VOICEVOX.app/Contents/Resources/app
+
       - name: Merge VOICEVOX ENGINE into prepackage/
+        if: startsWith(matrix.artifact_name, 'windows-') || startsWith(matrix.artifact_name, 'linux-')
         shell: bash
         run: |
           mv voicevox_engine/voicevox_engine/* prepackage/
           rm -rf voicevox_engine
 
+      - name: Merge VOICEVOX ENGINE into prepackage/VOICEVOX.app/Contents/MacOS/
+        if: startsWith(matrix.artifact_name, 'macos-')
+        shell: bash
+        run: |
+          mv voicevox_engine/voicevox_engine/* prepackage/VOICEVOX.app/Contents/MacOS/
+          rm -rf voicevox_engine
+
       - name: Show disk space (debug info)
         shell: bash
         run: |
@@ -417,6 +479,7 @@ jobs:
           - linux-cpu-appimage
           - windows-nvidia-nsis-web
           - windows-cpu-nsis-web
+          - macos-cpu-dmg
         include:
           # Linux NVIDIA GPU
           - artifact_name: linux-nvidia-appimage
@@ -444,6 +507,13 @@ jobs:
             package_name: voicevox-cpu
             nsis_web_artifact_name: 'VOICEVOX-CPU Web Setup ${version}.${ext}'
             os: windows-2019
+          # macOS CPU
+          - artifact_name: macos-cpu-dmg
+            engine_artifact_name: macos-cpu-prepackage
+            package_name: voicevox-cpu
+            macos_artifact_name: 'VOICEVOX ${version}.${ext}'
+            macos_executable_name: VOICEVOX
+            os: macos-11
 
     runs-on: ${{ matrix.os }}
     steps:
@@ -455,14 +525,27 @@ jobs:
       #       the AppImages have duplicate names.
       #       Files with the same name cannot be uploaded to a single GitHub Release,
       #       so different package/product names should be used for CPU/GPU builds.
-      - name: Replace package name
+      - name: Replace package name (for Windows and Ubuntu)
+        if: endsWith(matrix.artifact_name, '-nsis-web') || endsWith(matrix.artifact_name, '-appimage')
         shell: bash
         run: |
           # GPU: "name": "voicevox" => "name": "voicevox"
           # CPU: "name": "voicevox" => "name": "voicevox-cpu"
           sed -i 's/"name": "voicevox"/"name": "${{ matrix.package_name }}"/' package.json
           # sed -i 's/productName: "VOICEVOX"/productName: "${{ matrix.product_name }}"/' vue.config.js
 
+      # Rename executable file
+      # NOTE: The sed command of macOS is BSD sed,
+      #       so you cannot omit the backup extension after the -i option.
+      - name: Replace package name (for macOS)
+        if: endsWith(matrix.os, '-dmg')
+        shell: bash
+        run: |
+          # GPU: "name": "voicevox" => "name": "voicevox"
+          # CPU: "name": "voicevox" => "name": "voicevox-cpu"
+          sed -i '' 's/"name": "voicevox"/"name": "${{ matrix.package_name }}"/' package.json
+          # sed -i '' 's/productName: "VOICEVOX"/productName: "${{ matrix.product_name }}"/' vue.config.js
+
       - name: Download and extract engine-prepackage artifact
         uses: actions/download-artifact@v2
         with:
@@ -476,6 +559,17 @@ jobs:
           chmod +x "prepackage/${{ matrix.linux_executable_name }}"
           chmod +x "prepackage/run"
 
+      - name: Recover file permissions for macOS build
+        if: endsWith(matrix.artifact_name, '-dmg') # macOS
+        shell: bash
+        run: |
+          chmod +x "prepackage/VOICEVOX.app/Contents/MacOS/${{ matrix.macos_executable_name }}"
+          chmod +x "prepackage/VOICEVOX.app/Contents/MacOS/run"
+          chmod +x "prepackage/VOICEVOX.app/Contents/Frameworks/VOICEVOX Helper (GPU).app/Contents/MacOS/VOICEVOX Helper (GPU)"
+          chmod +x "prepackage/VOICEVOX.app/Contents/Frameworks/VOICEVOX Helper (Plugin).app/Contents/MacOS/VOICEVOX Helper (Plugin)"
+          chmod +x "prepackage/VOICEVOX.app/Contents/Frameworks/VOICEVOX Helper (Renderer).app/Contents/MacOS/VOICEVOX Helper (Renderer)"
+          chmod +x "prepackage/VOICEVOX.app/Contents/Frameworks/VOICEVOX Helper.app/Contents/MacOS/VOICEVOX Helper"
+
       - name: Show disk space (debug info)
         shell: bash
         run: |
@@ -526,13 +620,21 @@ jobs:
 
       # NOTE: prepackage can be removed before splitting nsis-web archive
       - name: Build Electron
+        if: endsWith(matrix.artifact_name, '-nsis-web') || endsWith(matrix.artifact_name, '-appimage') # windows and linux
         shell: bash
         env:
           NSIS_WEB_ARTIFACT_NAME: ${{ matrix.nsis_web_artifact_name }}
           LINUX_ARTIFACT_NAME: ${{ matrix.linux_artifact_name }}
           LINUX_EXECUTABLE_NAME: ${{ matrix.linux_executable_name }}
         run: npm run electron:build_pnever -- --prepackaged "prepackage/"
 
+      - name: Build Electron (for macOS)
+        if: endsWith(matrix.artifact_name, '-dmg') # macOS
+        shell: bash
+        env:
+          MACOS_ARTIFACT_NAME: ${{ matrix.macos_artifact_name }}
+        run: npm run electron:build_pnever -- --prepackaged "prepackage/VOICEVOX.app"
+
       - name: Show disk space (debug info)
         shell: bash
         run: |
@@ -546,6 +648,14 @@ jobs:
           path: |
             dist_electron/*.AppImage
 
+      - name: Upload macOS dmg artifact
+        if: endsWith(matrix.artifact_name, '-dmg')
+        uses: actions/upload-artifact@v2
+        with:
+          name: ${{ matrix.artifact_name }}
+          path: |
+            dist_electron/*.dmg
+
       - name: Create Windows NSIS Web artifact directory
         if: endsWith(matrix.artifact_name, '-nsis-web')
         shell: bash
@@ -586,13 +696,15 @@ jobs:
           - linux-cpu-appimage
           - windows-nvidia-nsis-web
           - windows-cpu-nsis-web
+          - macos-cpu-dmg
         include:
           - artifact_name: linux-nvidia-appimage
             appimage_7z_name: VOICEVOX.AppImage
           - artifact_name: linux-cpu-appimage
             appimage_7z_name: VOICEVOX-CPU.AppImage
           - artifact_name: windows-nvidia-nsis-web
           - artifact_name: windows-cpu-nsis-web
+          - artifact_name: macos-cpu-dmg
 
     runs-on: ${{ matrix.os }}
     steps:
@@ -680,3 +792,13 @@ jobs:
           tag: ${{ github.ref }} # == github.event.release.tag_name
           file_glob: true
           file: artifact/*.exe
+
+      # macOS dmg
+      - name: Upload macOS dmg to Release assets
+        if: endsWith(matrix.artifact_name, '-dmg')
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ github.ref }} # == github.event.release.tag_name
+          file_glob: true
+          file: artifact/*.dmg

vue.config.js

@@ -15,6 +15,9 @@ const LINUX_ARTIFACT_NAME = process.env.LINUX_ARTIFACT_NAME;
 // ${packageName}
 const LINUX_EXECUTABLE_NAME = process.env.LINUX_EXECUTABLE_NAME;
 
+// ${productName}-${version}.${ext}
+const MACOS_ARTIFACT_NAME = process.env.MACOS_ARTIFACT_NAME;
+
 module.exports = {
   configureWebpack: {
     devtool: "source-map",
@@ -85,6 +88,18 @@ module.exports = {
             },
           ],
         },
+        mac: {
+          artifactName:
+            MACOS_ARTIFACT_NAME !== "" ? MACOS_ARTIFACT_NAME : undefined,
+          icon: "public/icon-mac.png",
+          category: "public.app-category.utilities",
+          target: [
+            {
+              target: "dmg",
+              arch: ["x64"],
+            },
+          ],
+        },
       },
     },
   },