build: releaseDistBundle command to build bundles

Author: abose

README.md

@@ -70,8 +70,8 @@ If you want to generate the release builds locally directly while you are editin
 ```bash
 cd phoenix-desktop
 # To generate debug builds:
-npm run releaseSrcDebug
-# OR to generate release builds, just run `npm run releaseSrc`
+npm run releaseSrc
+# OR to generate debug builds, just run `npm run releaseSrcDebug`
 ```
 This is the easiest way to quickly debug issues directly from the phoenix source folder.
 
@@ -86,12 +86,29 @@ npm run build
 npm run release:prod
 # Other release options are `npm run release:dev` and `npm run release:staging` 
 
-# Now generate the tauri debug builds:
+# Now generate the tauri release builds:
 cd ../phoenix-desktop
-npm run releaseDistDebug
-# OR to generate release builds, just run `npm run releaseDist`
+npm run releaseDist
+# OR to debug, just run `npm run releaseDistDebug`
 ```
 
+#### Generating installers/AppImage and DMGs locally from `phoenix/dist` folder
+To generate the installers, use the commands
+```bash
+# You should first build the appropriate release build in `phoenix`.
+cd phoenix
+npm install
+npm run build
+npm run release:prod
+# Other release options are `npm run release:dev` and `npm run release:staging` 
+
+# Now generate the bundles
+cd ../phoenix-desktop
+npm run releaseDistBundle
+# will generate appimages/DMGs or nsix windows installers in target/release/bundle
+```
+
+
 ## Building release binaries and installers in GitHub actions
 The npm commands that begin with `_ci-*` are exclusively designed to execute in a GitHub Actions environment.
 These commands are not typically executed on your local machine unless you're actively working on the GitHub

package.json

@@ -8,13 +8,15 @@
         "tauriBuildDemoApp": "node src-build/createDemoReleaseConfig.js && tauri build --config ./src-tauri/tauri-local.conf.json",
         "_createSrcReleaseConfig": "node src-build/createSrcReleaseConfig.js",
         "_createDistReleaseConfig": "node src-build/createDistReleaseConfig.js",
+        "_createDistBundleReleaseConfig": "node src-build/createDistBundleReleaseConfig.js",
         "_createDistTestReleaseConfig": "node src-build/createDistTestReleaseConfig.js",
         "_ci-createDistReleaseConfig": "node src-build/ci-createDistReleaseConfig.js",
         "_ci-env-warn": "echo !!!This script is supposed to executed in github actions only. Ignore if you are seeing this message in a github actions log.",
         "releaseSrc": "npm run _make_src-node && npm run _createSrcReleaseConfig && tauri build --config ./src-tauri/tauri-local.conf.json",
-        "releaseSrcDebug": "npm run _make_src-node && npm run _createSrcReleaseConfig && tauri build --config ./src-tauri/tauri-local.conf.json --debug",
+        "releaseSrcDebug": "npm run _make_src-node && npm run _createSrcReleaseConfig && tauri build --config ./src-tauri/tauri-local.conf.json --debug --verbose",
         "releaseDist": "npm run _make_src-node && npm run _createDistReleaseConfig && tauri build --config ./src-tauri/tauri-local.conf.json",
-        "releaseDistDebug": "npm run _make_src-node && npm run _createDistReleaseConfig && tauri build --config ./src-tauri/tauri-local.conf.json --debug",
+        "releaseDistBundle": "npm run _make_src-node && npm run _createDistBundleReleaseConfig && tauri build --config ./src-tauri/tauri-local.conf.json --verbose",
+        "releaseDistDebug": "npm run _make_src-node && npm run _createDistReleaseConfig && tauri build --config ./src-tauri/tauri-local.conf.json --debug --verbose",
         "releaseDistTest": "npm run _make_src-node && npm run _createDistTestReleaseConfig && tauri build --config ./src-tauri/tauri-local.conf.json",
         "releaseDistTestDebug": "npm run _make_src-node && npm run _createDistTestReleaseConfig && tauri build --config ./src-tauri/tauri-local.conf.json --debug",
         "_src-node_npm_install": "cd src-tauri/src-node && npm ci --production && cd ../../ && npm run _src-node_remove_unsupported_bin",

src-build/createDistBundleReleaseConfig.js

@@ -0,0 +1,36 @@
+import {fileURLToPath} from "url";
+import {dirname} from "path";
+import fs from 'fs';
+import chalk from 'chalk';
+
+import {getPlatformDetails, patchTauriConfigWithMetricsHTML} from "./utils.js";
+import os from "os";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+async function createDistReleaseConfig() {
+    const platform = getPlatformDetails().platform;
+    const tauriConfigPath = (platform === "win") ? `${__dirname}\\..\\src-tauri\\tauri.conf.json`
+        : `${__dirname}/../src-tauri/tauri.conf.json`;
+    const tauriLocalConfigPath = (platform === "win") ? `${__dirname}\\..\\src-tauri\\tauri-local.conf.json`
+        : `${__dirname}/../src-tauri/tauri-local.conf.json`;
+    console.log("Reading Tauri config file: ", tauriConfigPath);
+    let configJson = JSON.parse(fs.readFileSync(tauriConfigPath));
+    console.log(chalk.cyan("\n!Updates and signing is disabled while creating msi, appimage and dmg installers. If you want to sign, use tauri build commands directly.\n"));
+    configJson.tauri.bundle.active = true;
+    configJson.tauri.updater.active = false;
+    configJson.build.distDir = '../../phoenix/dist/';
+    const phoenixVersion = configJson.package.version;
+    if(os.platform() === 'win32'){
+        configJson.tauri.windows[0].url = `https://phtauri.localhost/v${phoenixVersion}/`;
+    } else {
+        configJson.tauri.windows[0].url = `phtauri://localhost/v${phoenixVersion}/`;
+    }
+    patchTauriConfigWithMetricsHTML(configJson);
+    console.log("Window Boot url is: ", configJson.tauri.windows[0].url);
+    console.log("Writing new local config json ", tauriLocalConfigPath);
+    fs.writeFileSync(tauriLocalConfigPath, JSON.stringify(configJson, null, 4));
+}
+
+await createDistReleaseConfig();

src-build/createDistReleaseConfig.js

@@ -17,7 +17,7 @@ async function createDistReleaseConfig() {
         : `${__dirname}/../src-tauri/tauri-local.conf.json`;
     console.log("Reading Tauri config file: ", tauriConfigPath);
     let configJson = JSON.parse(fs.readFileSync(tauriConfigPath));
-    console.log(chalk.cyan("\n!Only creating executables. Creating msi, appimage and dmg installers are disabled in this build. If you want to create an installer, use: npm run tauri build manually after setting distDir in tauri conf!\n"));
+    console.log(chalk.cyan("\n!Only creating executables. Creating msi, appimage and dmg installers are disabled in this build. If you want to create an installer, use: npm run releaseDistBundle\n"));
     configJson.tauri.bundle.active = false;
     configJson.build.distDir = '../../phoenix/dist/';
     const phoenixVersion = configJson.package.version;

src-build/createSrcReleaseConfig.js

@@ -17,7 +17,7 @@ async function createSrcReleaseConfig() {
         : `${__dirname}/../src-tauri/tauri-local.conf.json`;
     console.log("Reading config file: ", tauriConfigPath);
     let configJson = JSON.parse(fs.readFileSync(tauriConfigPath));
-    console.log(chalk.cyan("\n!Only creating executables. Creating msi, appimage and dmg installers are disabled in this build. If you want to create an installer, use: npm run tauri build manually after setting distDir in tauri conf!\n"));
+    console.log(chalk.cyan("\n!Only creating executables. Creating msi, appimage and dmg installers are disabled in this build. If you want to create an installer, use: npm run releaseDistBundle\n"));
     configJson.tauri.bundle.active = false;
     configJson.build.distDir = '../../phoenix/src/'
     const phoenixVersion = configJson.package.version;

src-tauri/Cargo.lock

@@ -21,7 +21,7 @@ regex = "1.10.3"
 clipboard-files = "0.1.1"
 webbrowser = "0.8.12"
 serde = { version = "1.0", features = ["derive"] }
-tauri = { version = "1.5.4", features = [ "cli", "api-all", "updater", "devtools", "linux-protocol-headers"] }
+tauri = { version = "1.5.4", features = [ "cli", "api-all", "devtools", "linux-protocol-headers"] }
 winapi = { version = "0.3", features = ["fileapi"] }
 tauri-plugin-fs-extra = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v1" }
 tauri-plugin-window-state = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v1" }