chore: adding additional docs to signAndEditExecutable for windows (#9142)

Author: mmaietta

.changeset/mean-starfishes-deliver.md

@@ -0,0 +1,7 @@
+---
+"app-builder-lib": patch
+"builder-util": patch
+"dmg-builder": patch
+---
+
+chore: adding additional docs to signAndEditExecutable for windows

packages/app-builder-lib/scheme.json

@@ -6585,7 +6585,7 @@
         },
         "signAndEditExecutable": {
           "default": true,
-          "description": "Whether to sign and add metadata to executable. Advanced option.",
+          "description": "Whether to sign and add metadata to executable.\nMetadata includes information about the app name/description/version, publisher, copyright, etc.\nThis property also is responsible for adding the app icon and setting execution level.\n(Advanced option leveraging `rcedit`)",
           "type": "boolean"
         },
         "signExts": {

packages/app-builder-lib/src/options/winOptions.ts

@@ -52,7 +52,10 @@ export interface WindowsConfiguration extends PlatformSpecificBuildOptions {
   readonly requestedExecutionLevel?: RequestedExecutionLevel | null
 
   /**
-   * Whether to sign and add metadata to executable. Advanced option.
+   * Whether to sign and add metadata to executable.
+   * Metadata includes information about the app name/description/version, publisher, copyright, etc.
+   * This property also is responsible for adding the app icon and setting execution level.
+   * (Advanced option leveraging `rcedit`)
    * @default true
    */
   readonly signAndEditExecutable?: boolean

packages/builder-util/src/util.ts

@@ -124,7 +124,7 @@ export function exec(file: string, args?: Array<string> | null, options?: ExecFi
           const code = (error as any).code
           // https://github.com/npm/npm/issues/17624
           if (code === 1 && (file.toLowerCase().endsWith("npm") || file.toLowerCase().endsWith("npm.cmd")) && args?.includes("list") && args?.includes("--silent")) {
-            console.error({ file, code }, error.message)
+            log.debug({ file, code, message: error.message }, "`npm list` returned non-zero exit code, but it is expected (https://github.com/npm/npm/issues/17624)")
             resolve(stdout.toString())
             return
           }

packages/dmg-builder/src/dmg.ts

@@ -206,13 +206,13 @@ async function createStageDmg(tempDmg: string, appPath: string, volumeName: stri
   imageArgs.push("-fs", "APFS")
   imageArgs.push(tempDmg)
   await hdiUtil(imageArgs).catch(async e => {
-      if (hdiutilTransientExitCodes.has(e.code)) {
-        // Delay then create, then retry with verbose output
-        await new Promise(resolve => setTimeout(resolve, 3000))
-        return hdiUtil(addLogLevel(createArgs, true))
-      }
-      throw e
-    })
+    if (hdiutilTransientExitCodes.has(e.code)) {
+      // Delay then create, then retry with verbose output
+      await new Promise(resolve => setTimeout(resolve, 3000))
+      return hdiUtil(addLogLevel(createArgs, true))
+    }
+    throw e
+  })
   return tempDmg
 }