update build and release workflow (#1597)

- Clean up code and fix release.yml workflow
- Add zap-cli to .deb and .rpm packages via afterPack hook in Electron Builder
- Include zap-cli in .zip files via afterAllArtifactsBuild hook in Electron Builder
- Package ARM64 zap-cli binary for macOS ARM64 zap release

Author: dhchandw

.github/workflows/matter.yml

@@ -89,10 +89,7 @@ jobs:
       - name: Build & Release for Linux
         if: startsWith(matrix.os, 'ubuntu')
         run: |
-          npm run pack:linux
-          npm run pkg:linux
-          ls ./dist/
-          npm run pack:cli:linux
+          node src-script/build-release-package.js --platform l
 
           mv dist/zap-linux-amd64.deb dist/zap-linux-x64.deb
           mv dist/zap-linux-x86_64.rpm dist/zap-linux-x64.rpm

.github/workflows/release.yml

@@ -106,14 +106,11 @@
     "pack:win": "cross-env NODE_OPTIONS=--max-old-space-size=4096 electron-builder -w",
     "pack:mac": "cross-env NODE_OPTIONS=--max-old-space-size=4096 electron-builder -m",
     "pack:mac:native": "cross-env NODE_OPTIONS=--max-old-space-size=4096 electron-builder -m",
-    "pack:cli:linux": "node ./src-script/pack-cli.js -p linux",
-    "pack:cli:win": "node ./src-script/pack-cli.js -p win",
-    "pack:cli:mac": "node ./src-script/pack-cli.js -p mac",
     "pkg": "npx pkg --out-path dist/ --compress GZip --options max-old-space-size=4096 .",
     "pkg:linux": "npx pkg -t node18-linux-x64,node18-linux-arm64 --public --no-bytecode --output dist/zap-linux --compress GZip --options max-old-space-size=4096 .",
     "pkg-use-local-fork": "node ../pkg/lib-es5/bin.js -t node18-linux-x64 --output dist/zap-linux --compress GZip --options max-old-space-size=4096 .",
     "pkg:win": "npx pkg -t node18-win-x64,node18-win-arm64 --public --no-bytecode --output dist/zap-win --compress GZip --options max-old-space-size=4096 .",
-    "pkg:mac": "npx pkg -t node18-macos-x64 --output dist/zap-macos --compress GZip --options max-old-space-size=4096 .",
+    "pkg:mac": "npx pkg -t node18-macos-x64,node18-macos-arm64 --output dist/zap-macos --compress GZip --options max-old-space-size=4096 .",
     "dist": "node src-script/build-release-package.js --output dist/release",
     "dist:mac": "node src-script/build-release-package.js --platform m --output dist/release",
     "dist:win": "node src-script/build-release-package.js --platform w --output dist/release",
@@ -225,8 +222,8 @@
   "build": {
     "appId": "zap.id",
     "artifactName": "${productName}-${os}-${arch}.${ext}",
-    "afterPack": "./src-script/pack-apack-win-linux.js",
-    "afterAllArtifactBuild": "./src-script/pack-apack-mac.js",
+    "afterPack": "./src-script/after-pack-linux.js",
+    "afterAllArtifactBuild": "./src-script/after-all-artifacts.js",
     "mac": {
       "category": "public.app-category.developer-tools",
       "darkModeSupport": true,

package.json

@@ -0,0 +1,86 @@
+/**
+ * This script runs after all artifacts are built by Electron Builder.
+ * It adds additional files (e.g., apack.json, zap.png, zap-cli) to the final
+ * .zip artifacts for macOS, Windows, and Linux platforms.
+ */
+const fs = require('fs')
+const path = require('path')
+const Seven = require('node-7z')
+const sevenBin = require('7zip-bin')
+const pathTo7zip = sevenBin.path7za
+
+exports.default = async function (buildResult) {
+  const zipFiles = buildResult?.artifactPaths || []
+
+  for (const zipPath of zipFiles) {
+    if (!zipPath.endsWith('.zip')) continue
+    if (
+      !(
+        zipPath.includes('mac') ||
+        zipPath.includes('win') ||
+        zipPath.includes('linux')
+      )
+    )
+      continue
+
+    const additions = [
+      path.join(buildResult.outDir, '../apack.json'),
+      path.join(buildResult.outDir, '../src/assets/zap.png')
+    ]
+
+    // Detect platform and arch from filename
+    const platform = zipPath.includes('mac')
+      ? 'macos'
+      : zipPath.includes('linux')
+        ? 'linux'
+        : zipPath.includes('win')
+          ? 'win'
+          : null
+
+    const arch = zipPath.includes('arm64') ? 'arm64' : 'x64'
+
+    if (!platform) continue
+
+    // Compose zap-cli binary name
+    const cliName =
+      platform === 'win' ? `zap-win-${arch}.exe` : `zap-${platform}-${arch}`
+
+    const cliPath = path.join(buildResult.outDir, '../dist', cliName)
+
+    if (fs.existsSync(cliPath)) {
+      const tempName = platform === 'win' ? 'zap-cli.exe' : 'zap-cli'
+      const tempPath = path.join(__dirname, tempName)
+
+      // Copy to temp with desired name
+      fs.copyFileSync(cliPath, tempPath)
+
+      additions.push(tempPath)
+
+      // Clean up after zip
+      process.on('exit', () => {
+        if (fs.existsSync(tempPath)) fs.unlinkSync(tempPath)
+      })
+    } else {
+      console.warn(`⚠️  zap-cli not found for ${platform}-${arch}: ${cliPath}`)
+    }
+
+    // Add files to zip
+    for (const filePath of additions) {
+      await new Promise((resolve, reject) => {
+        const stream = Seven.add(zipPath, filePath, {
+          $bin: pathTo7zip,
+          $progress: true
+        })
+        stream.on('end', resolve)
+        stream.on('error', (err) => {
+          console.error(`❌ Error adding ${filePath}:`, err.stderr || err)
+          reject(err)
+        })
+      })
+
+      console.log(
+        `✅ Added ${path.basename(filePath)} to ${path.basename(zipPath)}`
+      )
+    }
+  }
+}

src-script/after-all-artifacts.js

@@ -0,0 +1,38 @@
+/**
+ * after-pack-linux-assets.js
+ * Adds zap-cli, apack.json, and zap.png to Linux app output before .deb/.rpm packaging.
+ */
+const scriptUtil = require('./script-util.js')
+const path = require('path')
+const fs = require('fs')
+
+exports.default = async function (context) {
+  const { electronPlatformName, appOutDir, outDir, arch } = context
+
+  if (electronPlatformName === 'linux') {
+    // 1. Copy apack.json and zap.png
+    await scriptUtil.executeCmd({}, 'npx', [
+      'copyfiles',
+      '-V',
+      '-f',
+      path.resolve(outDir, '../apack.json'),
+      path.resolve(outDir, '../src/assets/zap.png'),
+      appOutDir
+    ])
+    console.log('✅ apack.json and zap.png copied to Linux appOutDir')
+
+    // 2. Copy zap-cli for correct arch
+    const archName = arch === 3 ? 'arm64' : 'x64' // arch === 3 => arm64, else x64
+    const cliSource = path.resolve(outDir, `../dist/zap-linux-${archName}`)
+    const cliDest = path.join(appOutDir, 'zap-cli')
+
+    if (!fs.existsSync(cliSource)) {
+      throw new Error(`❌ zap-cli binary not found at ${cliSource}`)
+    }
+
+    fs.copyFileSync(cliSource, cliDest)
+    fs.chmodSync(cliDest, 0o755)
+
+    console.log(`✅ zap-cli (${archName}) copied to ${cliDest}`)
+  }
+}

src-script/after-pack-linux.js

@@ -32,9 +32,8 @@ async function buildForOS(osName, outputPath) {
   switch (osName) {
     case 'm':
       console.log(`Building for Mac... Output: ${outputPath}`)
-      await scriptUtil.executeCmd({}, 'npm', ['run', 'pack:mac']) // Building electron app
       await scriptUtil.executeCmd({}, 'npm', ['run', 'pkg:mac']) // Building zap-cli
-      await scriptUtil.executeCmd({}, 'npm', ['run', 'pack:cli:mac']) // Adding zap-cli to zip file
+      await scriptUtil.executeCmd({}, 'npm', ['run', 'pack:mac']) // Building electron app
       if (outputPath) {
         await scriptUtil.executeCmd({}, 'mv', [
           './dist/zap-mac-x64.zip',
@@ -49,9 +48,8 @@ async function buildForOS(osName, outputPath) {
 
     case 'w':
       console.log(`Building for Windows... Output: ${outputPath}`)
-      await scriptUtil.executeCmd({}, 'npm', ['run', 'pack:win']) // Building electron app
       await scriptUtil.executeCmd({}, 'npm', ['run', 'pkg:win']) // Building zap-cli
-      await scriptUtil.executeCmd({}, 'npm', ['run', 'pack:cli:win']) // Adding zap-cli to zip file
+      await scriptUtil.executeCmd({}, 'npm', ['run', 'pack:win']) // Building electron app
       if (outputPath) {
         await scriptUtil.executeCmd({}, 'mv', [
           'dist/zap-win-x64.zip',
@@ -66,9 +64,8 @@ async function buildForOS(osName, outputPath) {
 
     case 'l':
       console.log(`Building for Linux... Output: ${outputPath}`)
-      await scriptUtil.executeCmd({}, 'npm', ['run', 'pack:linux']) // Building electron app
       await scriptUtil.executeCmd({}, 'npm', ['run', 'pkg:linux']) // Building zap-cli
-      await scriptUtil.executeCmd({}, 'npm', ['run', 'pack:cli:linux']) // Adding zap-cli to zip file
+      await scriptUtil.executeCmd({}, 'npm', ['run', 'pack:linux']) // Building electron app
       if (outputPath) {
         await scriptUtil.executeCmd({}, 'mv', [
           'dist/zap-linux-x64.zip',

src-script/build-release-package.js

@@ -4,4 +4,4 @@
 # to get source build to compile via npm install or npm ci
 #
 apt-get update
-apt-get install -y --fix-missing libpixman-1-dev libcairo-dev libsdl-pango-dev libjpeg-dev libgif-dev
+apt-get install -y --fix-missing libpixman-1-dev libcairo-dev libsdl-pango-dev libjpeg-dev libgif-dev rpm