feat: add config options for setting MinVersion and `MaxVersionTest…

…ed` fields in appx manifest (#8142)
electron-userland · Mar 20, 2024 · 8160363 · 8160363
1 parent 9f4b458
commit 8160363
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 2 deletions.
diff --git a/.changeset/pretty-lemons-trade.md b/.changeset/pretty-lemons-trade.md
@@ -0,0 +1,5 @@
+---
+"app-builder-lib": minor
+---
+
+feat: add config options for setting `MinVersion` and `MaxVersionTested` fields in appx manifest
diff --git a/docs/configuration/appx.md b/docs/configuration/appx.md
@@ -15,6 +15,8 @@ All options are optional. All required for AppX configuration is inferred and co
 <li><code id="AppXOptions-customExtensionsPath">customExtensionsPath</code> String - Relative path to custom extensions xml to be included in an <code>appmanifest.xml</code>.</li>
 <li><code id="AppXOptions-showNameOnTiles">showNameOnTiles</code> = <code>false</code> Boolean - Whether to overlay the app’s name on top of tile images on the Start screen. Defaults to <code>false</code>. (<a href="https://docs.microsoft.com/en-us/uwp/schemas/appxpackage/uapmanifestschema/element-uap-shownameontiles">https://docs.microsoft.com/en-us/uwp/schemas/appxpackage/uapmanifestschema/element-uap-shownameontiles</a>) in the dependencies.</li>
 <li><code id="AppXOptions-setBuildNumber">setBuildNumber</code> = <code>false</code> Boolean - Whether to set build number. See <a href="https://github.com/electron-userland/electron-builder/issues/3875">https://github.com/electron-userland/electron-builder/issues/3875</a></li>
+<li><code id="AppXOptions-minVersion">minVersion</code> = <code>arch === Arch.arm64 ? &quot;10.0.16299.0&quot; : &quot;10.0.14316.0&quot;</code> String | “undefined” - Set the MinVersion field in the appx manifest.xml</li>
+<li><code id="AppXOptions-maxVersionTested">maxVersionTested</code> = <code>arch === Arch.arm64 ? &quot;10.0.16299.0&quot; : &quot;10.0.14316.0&quot;</code> String | “undefined” - Set the <code>MaxVersionTested</code> field in the appx manifest.xml</li>
 </ul>
 <p>Inherited from <code>TargetSpecificOptions</code>:</p>
 <ul>

diff --git a/packages/app-builder-lib/scheme.json b/packages/app-builder-lib/scheme.json
@@ -223,6 +223,22 @@
             }
           ]
         },
+        "maxVersionTested": {
+          "default": "arch === Arch.arm64 ? \"10.0.16299.0\" : \"10.0.14316.0\"",
+          "description": "Set the `MaxVersionTested` field in the appx manifest.xml",
+          "type": [
+            "null",
+            "string"
+          ]
+        },
+        "minVersion": {
+          "default": "arch === Arch.arm64 ? \"10.0.16299.0\" : \"10.0.14316.0\"",
+          "description": "Set the MinVersion field in the appx manifest.xml",
+          "type": [
+            "null",
+            "string"
+          ]
+        },
         "publish": {
           "anyOf": [
             {

diff --git a/packages/app-builder-lib/src/options/AppXOptions.ts b/packages/app-builder-lib/src/options/AppXOptions.ts
@@ -69,6 +69,18 @@ export interface AppXOptions extends TargetSpecificOptions {
    */
   readonly setBuildNumber?: boolean
 
+  /**
+   * Set the MinVersion field in the appx manifest.xml
+   * @default arch === Arch.arm64 ? "10.0.16299.0" : "10.0.14316.0"
+   */
+  readonly minVersion?: string | null
+
+  /**
+   * Set the `MaxVersionTested` field in the appx manifest.xml
+   * @default arch === Arch.arm64 ? "10.0.16299.0" : "10.0.14316.0"
+   */
+  readonly maxVersionTested?: string | null
+
   /** @private */
   readonly makeappxArgs?: Array<string> | null
 }
diff --git a/packages/app-builder-lib/src/targets/AppxTarget.ts b/packages/app-builder-lib/src/targets/AppxTarget.ts
@@ -180,6 +180,7 @@ export default class AppXTarget extends Target {
     const executable = `app\\${appInfo.productFilename}.exe`
     const displayName = options.displayName || appInfo.productName
     const extensions = await this.getExtensions(executable, displayName)
+    const archSpecificMinVersion = arch === Arch.arm64 ? "10.0.16299.0" : "10.0.14316.0"
 
     const manifest = (await readFile(path.join(getTemplatePath("appx"), "appxmanifest.xml"), "utf8")).replace(/\${([a-zA-Z0-9]+)}/g, (match, p1): string => {
       switch (p1) {
@@ -252,10 +253,10 @@ export default class AppXTarget extends Target {
           return extensions
 
         case "minVersion":
-          return arch === Arch.arm64 ? "10.0.16299.0" : "10.0.14316.0"
+          return options.minVersion || archSpecificMinVersion
 
         case "maxVersionTested":
-          return arch === Arch.arm64 ? "10.0.16299.0" : "10.0.14316.0"
+          return options.maxVersionTested || options.minVersion || archSpecificMinVersion
 
         default:
           throw new Error(`Macro ${p1} is not defined`)

diff --git a/test/src/windows/appxTest.ts b/test/src/windows/appxTest.ts
@@ -65,6 +65,8 @@ it(
       cscKeyPassword: "test",
       appx: {
         languages: ["de-DE", "ru-RU"],
+        minVersion: "10.0.16299.0",
+        maxVersionTested: "10.0.16299.0",
       },
     },
   })