app-builder-lib 27.0.0-alpha.12 → 27.0.0-alpha.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/asar/asarUtil.js +1 -1
- package/dist/asar/asarUtil.js.map +1 -1
- package/dist/codeSign/certInfo.d.ts +4 -1
- package/dist/codeSign/certInfo.d.ts.map +1 -1
- package/dist/codeSign/certInfo.js +5 -3
- package/dist/codeSign/certInfo.js.map +1 -1
- package/dist/codeSign/forceCodeSigning.d.ts +22 -0
- package/dist/codeSign/forceCodeSigning.d.ts.map +1 -0
- package/dist/codeSign/forceCodeSigning.js +18 -0
- package/dist/codeSign/forceCodeSigning.js.map +1 -0
- package/dist/codeSign/mac/macCodeSign.d.ts +13 -1
- package/dist/codeSign/mac/macCodeSign.d.ts.map +1 -1
- package/dist/codeSign/mac/macCodeSign.js +29 -2
- package/dist/codeSign/mac/macCodeSign.js.map +1 -1
- package/dist/codeSign/mac/macSignatureVerifier.d.ts +23 -0
- package/dist/codeSign/mac/macSignatureVerifier.d.ts.map +1 -0
- package/dist/codeSign/mac/macSignatureVerifier.js +96 -0
- package/dist/codeSign/mac/macSignatureVerifier.js.map +1 -0
- package/dist/codeSign/win/authenticodeSignature.d.ts +14 -2
- package/dist/codeSign/win/authenticodeSignature.d.ts.map +1 -1
- package/dist/codeSign/win/authenticodeSignature.js +78 -30
- package/dist/codeSign/win/authenticodeSignature.js.map +1 -1
- package/dist/codeSign/win/pkcs11SignManager.d.ts.map +1 -1
- package/dist/codeSign/win/pkcs11SignManager.js +4 -3
- package/dist/codeSign/win/pkcs11SignManager.js.map +1 -1
- package/dist/codeSign/win/publisherName.d.ts +31 -0
- package/dist/codeSign/win/publisherName.d.ts.map +1 -0
- package/dist/codeSign/win/publisherName.js +78 -0
- package/dist/codeSign/win/publisherName.js.map +1 -0
- package/dist/codeSign/win/signtoolBaseSignManager.d.ts +16 -9
- package/dist/codeSign/win/signtoolBaseSignManager.d.ts.map +1 -1
- package/dist/codeSign/win/signtoolBaseSignManager.js +46 -35
- package/dist/codeSign/win/signtoolBaseSignManager.js.map +1 -1
- package/dist/codeSign/win/verifyUpdatePublisher.d.ts.map +1 -1
- package/dist/codeSign/win/verifyUpdatePublisher.js +7 -4
- package/dist/codeSign/win/verifyUpdatePublisher.js.map +1 -1
- package/dist/codeSign/win/windowsSignAzureManager.d.ts +1 -1
- package/dist/codeSign/win/windowsSignAzureManager.d.ts.map +1 -1
- package/dist/codeSign/win/windowsSignAzureManager.js +24 -6
- package/dist/codeSign/win/windowsSignAzureManager.js.map +1 -1
- package/dist/configuration.d.ts +46 -3
- package/dist/configuration.d.ts.map +1 -1
- package/dist/configuration.js.map +1 -1
- package/dist/electron/mac/asarIntegrityDigest.js +2 -2
- package/dist/electron/mac/asarIntegrityDigest.js.map +1 -1
- package/dist/electron/mac/electronMacUtils.d.ts +3 -2
- package/dist/electron/mac/electronMacUtils.d.ts.map +1 -1
- package/dist/electron/mac/electronMacUtils.js +3 -2
- package/dist/electron/mac/electronMacUtils.js.map +1 -1
- package/dist/fileMatcher.d.ts.map +1 -1
- package/dist/fileMatcher.js +4 -2
- package/dist/fileMatcher.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4 -3
- package/dist/index.js.map +1 -1
- package/dist/indexInternal.d.ts +7 -2
- package/dist/indexInternal.d.ts.map +1 -1
- package/dist/indexInternal.js +6 -2
- package/dist/indexInternal.js.map +1 -1
- package/dist/linuxPackager.js +1 -1
- package/dist/linuxPackager.js.map +1 -1
- package/dist/macPackager.d.ts +26 -0
- package/dist/macPackager.d.ts.map +1 -1
- package/dist/macPackager.js +168 -12
- package/dist/macPackager.js.map +1 -1
- package/dist/options/PlatformSpecificBuildOptions.d.ts +15 -12
- package/dist/options/PlatformSpecificBuildOptions.d.ts.map +1 -1
- package/dist/options/PlatformSpecificBuildOptions.js.map +1 -1
- package/dist/options/SquirrelWindowsOptions.d.ts +3 -0
- package/dist/options/SquirrelWindowsOptions.d.ts.map +1 -1
- package/dist/options/SquirrelWindowsOptions.js.map +1 -1
- package/dist/options/macOptions.d.ts +7 -2
- package/dist/options/macOptions.d.ts.map +1 -1
- package/dist/options/macOptions.js.map +1 -1
- package/dist/options/winOptions.d.ts +61 -15
- package/dist/options/winOptions.d.ts.map +1 -1
- package/dist/options/winOptions.js +20 -0
- package/dist/options/winOptions.js.map +1 -1
- package/dist/packager.d.ts +1 -0
- package/dist/packager.d.ts.map +1 -1
- package/dist/packager.js +7 -2
- package/dist/packager.js.map +1 -1
- package/dist/platformPackager.d.ts +14 -5
- package/dist/platformPackager.d.ts.map +1 -1
- package/dist/platformPackager.js +44 -13
- package/dist/platformPackager.js.map +1 -1
- package/dist/publish/PublishManager.d.ts +3 -0
- package/dist/publish/PublishManager.d.ts.map +1 -1
- package/dist/publish/PublishManager.js +50 -16
- package/dist/publish/PublishManager.js.map +1 -1
- package/dist/publish/manifestUploadCheck.d.ts +10 -0
- package/dist/publish/manifestUploadCheck.d.ts.map +1 -0
- package/dist/publish/manifestUploadCheck.js +75 -0
- package/dist/publish/manifestUploadCheck.js.map +1 -0
- package/dist/publish/updateInfoBuilder.d.ts.map +1 -1
- package/dist/publish/updateInfoBuilder.js +51 -17
- package/dist/publish/updateInfoBuilder.js.map +1 -1
- package/dist/publish/updateManifestVerifier.d.ts +22 -0
- package/dist/publish/updateManifestVerifier.d.ts.map +1 -0
- package/dist/publish/updateManifestVerifier.js +65 -0
- package/dist/publish/updateManifestVerifier.js.map +1 -0
- package/dist/targets/ArchiveTarget.d.ts.map +1 -1
- package/dist/targets/ArchiveTarget.js +6 -2
- package/dist/targets/ArchiveTarget.js.map +1 -1
- package/dist/targets/archive.d.ts.map +1 -1
- package/dist/targets/archive.js +3 -3
- package/dist/targets/archive.js.map +1 -1
- package/dist/targets/linux/FlatpakTarget.js +5 -5
- package/dist/targets/linux/FlatpakTarget.js.map +1 -1
- package/dist/targets/linux/FpmTarget.d.ts.map +1 -1
- package/dist/targets/linux/FpmTarget.js +10 -7
- package/dist/targets/linux/FpmTarget.js.map +1 -1
- package/dist/targets/linux/LinuxTargetHelper.js +1 -1
- package/dist/targets/linux/LinuxTargetHelper.js.map +1 -1
- package/dist/targets/linux/appimage/AppImageTarget.d.ts.map +1 -1
- package/dist/targets/linux/appimage/AppImageTarget.js +6 -1
- package/dist/targets/linux/appimage/AppImageTarget.js.map +1 -1
- package/dist/targets/linux/appimage/appImageUtil.js +9 -9
- package/dist/targets/linux/appimage/appImageUtil.js.map +1 -1
- package/dist/targets/linux/flatpakBundle.d.ts.map +1 -1
- package/dist/targets/linux/flatpakBundle.js +25 -20
- package/dist/targets/linux/flatpakBundle.js.map +1 -1
- package/dist/targets/linux/snap/coreLegacy.d.ts.map +1 -1
- package/dist/targets/linux/snap/coreLegacy.js +22 -6
- package/dist/targets/linux/snap/coreLegacy.js.map +1 -1
- package/dist/targets/linux/snap/snapPlugs.d.ts +2 -2
- package/dist/targets/linux/snap/snapPlugs.d.ts.map +1 -1
- package/dist/targets/linux/snap/snapPlugs.js +1 -1
- package/dist/targets/linux/snap/snapPlugs.js.map +1 -1
- package/dist/targets/linux/snap/snapcraftBuilder.d.ts.map +1 -1
- package/dist/targets/linux/snap/snapcraftBuilder.js +19 -17
- package/dist/targets/linux/snap/snapcraftBuilder.js.map +1 -1
- package/dist/targets/mac/MacTargetHelper.d.ts +15 -3
- package/dist/targets/mac/MacTargetHelper.d.ts.map +1 -1
- package/dist/targets/mac/MacTargetHelper.js +96 -13
- package/dist/targets/mac/MacTargetHelper.js.map +1 -1
- package/dist/targets/mac/pkg.d.ts.map +1 -1
- package/dist/targets/mac/pkg.js +7 -5
- package/dist/targets/mac/pkg.js.map +1 -1
- package/dist/targets/win/nsis/NsisTarget.d.ts.map +1 -1
- package/dist/targets/win/nsis/NsisTarget.js +8 -2
- package/dist/targets/win/nsis/NsisTarget.js.map +1 -1
- package/dist/targets/win/nsis/nsisOptions.d.ts +1 -1
- package/dist/targets/win/nsis/nsisOptions.js.map +1 -1
- package/dist/toolsets/nsis.js +1 -1
- package/dist/toolsets/nsis.js.map +1 -1
- package/dist/toolsets/wine.d.ts +3 -0
- package/dist/toolsets/wine.d.ts.map +1 -1
- package/dist/toolsets/wine.js +14 -5
- package/dist/toolsets/wine.js.map +1 -1
- package/dist/util/appFileCopier.d.ts.map +1 -1
- package/dist/util/appFileCopier.js +9 -3
- package/dist/util/appFileCopier.js.map +1 -1
- package/dist/util/buildOutputVerifier.d.ts +40 -0
- package/dist/util/buildOutputVerifier.d.ts.map +1 -0
- package/dist/util/buildOutputVerifier.js +420 -0
- package/dist/util/buildOutputVerifier.js.map +1 -0
- package/dist/util/config/fileOptions.js +2 -2
- package/dist/util/config/fileOptions.js.map +1 -1
- package/dist/util/config/legacyConfigGuard.d.ts.map +1 -1
- package/dist/util/config/legacyConfigGuard.js +2 -2
- package/dist/util/config/legacyConfigGuard.js.map +1 -1
- package/dist/util/config/legacyOptions.d.ts +9 -2
- package/dist/util/config/legacyOptions.d.ts.map +1 -1
- package/dist/util/config/legacyOptions.js +8 -2
- package/dist/util/config/legacyOptions.js.map +1 -1
- package/dist/util/electronGet.d.ts.map +1 -1
- package/dist/util/electronGet.js +3 -1
- package/dist/util/electronGet.js.map +1 -1
- package/dist/util/flags.d.ts.map +1 -1
- package/dist/util/flags.js +3 -9
- package/dist/util/flags.js.map +1 -1
- package/dist/util/mac/macosIconComposer.d.ts.map +1 -1
- package/dist/util/mac/macosIconComposer.js +6 -5
- package/dist/util/mac/macosIconComposer.js.map +1 -1
- package/dist/util/macroExpander.js +1 -1
- package/dist/util/macroExpander.js.map +1 -1
- package/dist/util/nativeBinaryVerifier.d.ts.map +1 -1
- package/dist/util/nativeBinaryVerifier.js +3 -1
- package/dist/util/nativeBinaryVerifier.js.map +1 -1
- package/dist/util/packageMetadata.js +1 -1
- package/dist/util/packageMetadata.js.map +1 -1
- package/dist/util/removedEnvVars.d.ts +2 -0
- package/dist/util/removedEnvVars.d.ts.map +1 -1
- package/dist/util/removedEnvVars.js +15 -1
- package/dist/util/removedEnvVars.js.map +1 -1
- package/dist/util/streamSpawnToFile.d.ts +3 -1
- package/dist/util/streamSpawnToFile.d.ts.map +1 -1
- package/dist/util/streamSpawnToFile.js +6 -2
- package/dist/util/streamSpawnToFile.js.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/version.js.map +1 -1
- package/dist/vm/ParallelsVm.d.ts +10 -0
- package/dist/vm/ParallelsVm.d.ts.map +1 -1
- package/dist/vm/ParallelsVm.js +22 -8
- package/dist/vm/ParallelsVm.js.map +1 -1
- package/dist/vm/PwshVm.d.ts +0 -1
- package/dist/vm/PwshVm.d.ts.map +1 -1
- package/dist/vm/PwshVm.js +10 -15
- package/dist/vm/PwshVm.js.map +1 -1
- package/dist/vm/WineVm.d.ts.map +1 -1
- package/dist/vm/WineVm.js +4 -4
- package/dist/vm/WineVm.js.map +1 -1
- package/dist/vm/vm.d.ts +9 -3
- package/dist/vm/vm.d.ts.map +1 -1
- package/dist/vm/vm.js +40 -32
- package/dist/vm/vm.js.map +1 -1
- package/dist/winPackager.d.ts +16 -1
- package/dist/winPackager.d.ts.map +1 -1
- package/dist/winPackager.js +77 -19
- package/dist/winPackager.js.map +1 -1
- package/package.json +9 -9
- package/scheme.json +497 -23
- package/templates/nsis/include/allowOnlyOneInstallerInstance.nsh +14 -9
- package/dist/vm/MonoVm.d.ts +0 -9
- package/dist/vm/MonoVm.d.ts.map +0 -1
- package/dist/vm/MonoVm.js +0 -16
- package/dist/vm/MonoVm.js.map +0 -1
package/scheme.json
CHANGED
|
@@ -557,6 +557,17 @@
|
|
|
557
557
|
"null",
|
|
558
558
|
"string"
|
|
559
559
|
]
|
|
560
|
+
},
|
|
561
|
+
"verifyUpdateCodeSignature": {
|
|
562
|
+
"anyOf": [
|
|
563
|
+
{
|
|
564
|
+
"const": false,
|
|
565
|
+
"type": "boolean"
|
|
566
|
+
},
|
|
567
|
+
{
|
|
568
|
+
"type": "null"
|
|
569
|
+
}
|
|
570
|
+
]
|
|
560
571
|
}
|
|
561
572
|
},
|
|
562
573
|
"required": [
|
|
@@ -645,6 +656,17 @@
|
|
|
645
656
|
"null",
|
|
646
657
|
"string"
|
|
647
658
|
]
|
|
659
|
+
},
|
|
660
|
+
"verifyUpdateCodeSignature": {
|
|
661
|
+
"anyOf": [
|
|
662
|
+
{
|
|
663
|
+
"const": false,
|
|
664
|
+
"type": "boolean"
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
"type": "null"
|
|
668
|
+
}
|
|
669
|
+
]
|
|
648
670
|
}
|
|
649
671
|
},
|
|
650
672
|
"required": [
|
|
@@ -1350,6 +1372,353 @@
|
|
|
1350
1372
|
},
|
|
1351
1373
|
"type": "object"
|
|
1352
1374
|
},
|
|
1375
|
+
"ExecutablesConfig": {
|
|
1376
|
+
"additionalProperties": false,
|
|
1377
|
+
"description": "The locations of host programs, by {@link ExecutableName}. An unset or `null` entry uses the built-in default locations.",
|
|
1378
|
+
"properties": {
|
|
1379
|
+
"actool": {
|
|
1380
|
+
"anyOf": [
|
|
1381
|
+
{
|
|
1382
|
+
"items": {
|
|
1383
|
+
"type": "string"
|
|
1384
|
+
},
|
|
1385
|
+
"type": "array"
|
|
1386
|
+
},
|
|
1387
|
+
{
|
|
1388
|
+
"type": [
|
|
1389
|
+
"null",
|
|
1390
|
+
"string"
|
|
1391
|
+
]
|
|
1392
|
+
}
|
|
1393
|
+
],
|
|
1394
|
+
"description": "One file:// URI, or a list of them, of the `actool` executable on the build machine, such as `file:///opt/homebrew/bin/actool` or `file:///C:/Program%20Files/actool/actool.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1395
|
+
},
|
|
1396
|
+
"codesign": {
|
|
1397
|
+
"anyOf": [
|
|
1398
|
+
{
|
|
1399
|
+
"items": {
|
|
1400
|
+
"type": "string"
|
|
1401
|
+
},
|
|
1402
|
+
"type": "array"
|
|
1403
|
+
},
|
|
1404
|
+
{
|
|
1405
|
+
"type": [
|
|
1406
|
+
"null",
|
|
1407
|
+
"string"
|
|
1408
|
+
]
|
|
1409
|
+
}
|
|
1410
|
+
],
|
|
1411
|
+
"description": "One file:// URI, or a list of them, of the `codesign` executable on the build machine, such as `file:///opt/homebrew/bin/codesign` or `file:///C:/Program%20Files/codesign/codesign.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1412
|
+
},
|
|
1413
|
+
"flatpak": {
|
|
1414
|
+
"anyOf": [
|
|
1415
|
+
{
|
|
1416
|
+
"items": {
|
|
1417
|
+
"type": "string"
|
|
1418
|
+
},
|
|
1419
|
+
"type": "array"
|
|
1420
|
+
},
|
|
1421
|
+
{
|
|
1422
|
+
"type": [
|
|
1423
|
+
"null",
|
|
1424
|
+
"string"
|
|
1425
|
+
]
|
|
1426
|
+
}
|
|
1427
|
+
],
|
|
1428
|
+
"description": "One file:// URI, or a list of them, of the `flatpak` executable on the build machine, such as `file:///opt/homebrew/bin/flatpak` or `file:///C:/Program%20Files/flatpak/flatpak.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1429
|
+
},
|
|
1430
|
+
"flatpak-builder": {
|
|
1431
|
+
"anyOf": [
|
|
1432
|
+
{
|
|
1433
|
+
"items": {
|
|
1434
|
+
"type": "string"
|
|
1435
|
+
},
|
|
1436
|
+
"type": "array"
|
|
1437
|
+
},
|
|
1438
|
+
{
|
|
1439
|
+
"type": [
|
|
1440
|
+
"null",
|
|
1441
|
+
"string"
|
|
1442
|
+
]
|
|
1443
|
+
}
|
|
1444
|
+
],
|
|
1445
|
+
"description": "One file:// URI, or a list of them, of the `flatpak-builder` executable on the build machine, such as `file:///opt/homebrew/bin/flatpak-builder` or `file:///C:/Program%20Files/flatpak-builder/flatpak-builder.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1446
|
+
},
|
|
1447
|
+
"hdiutil": {
|
|
1448
|
+
"anyOf": [
|
|
1449
|
+
{
|
|
1450
|
+
"items": {
|
|
1451
|
+
"type": "string"
|
|
1452
|
+
},
|
|
1453
|
+
"type": "array"
|
|
1454
|
+
},
|
|
1455
|
+
{
|
|
1456
|
+
"type": [
|
|
1457
|
+
"null",
|
|
1458
|
+
"string"
|
|
1459
|
+
]
|
|
1460
|
+
}
|
|
1461
|
+
],
|
|
1462
|
+
"description": "One file:// URI, or a list of them, of the `hdiutil` executable on the build machine, such as `file:///opt/homebrew/bin/hdiutil` or `file:///C:/Program%20Files/hdiutil/hdiutil.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1463
|
+
},
|
|
1464
|
+
"lzip": {
|
|
1465
|
+
"anyOf": [
|
|
1466
|
+
{
|
|
1467
|
+
"items": {
|
|
1468
|
+
"type": "string"
|
|
1469
|
+
},
|
|
1470
|
+
"type": "array"
|
|
1471
|
+
},
|
|
1472
|
+
{
|
|
1473
|
+
"type": [
|
|
1474
|
+
"null",
|
|
1475
|
+
"string"
|
|
1476
|
+
]
|
|
1477
|
+
}
|
|
1478
|
+
],
|
|
1479
|
+
"description": "One file:// URI, or a list of them, of the `lzip` executable on the build machine, such as `file:///opt/homebrew/bin/lzip` or `file:///C:/Program%20Files/lzip/lzip.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1480
|
+
},
|
|
1481
|
+
"mono": {
|
|
1482
|
+
"anyOf": [
|
|
1483
|
+
{
|
|
1484
|
+
"items": {
|
|
1485
|
+
"type": "string"
|
|
1486
|
+
},
|
|
1487
|
+
"type": "array"
|
|
1488
|
+
},
|
|
1489
|
+
{
|
|
1490
|
+
"type": [
|
|
1491
|
+
"null",
|
|
1492
|
+
"string"
|
|
1493
|
+
]
|
|
1494
|
+
}
|
|
1495
|
+
],
|
|
1496
|
+
"description": "One file:// URI, or a list of them, of the `mono` executable on the build machine, such as `file:///opt/homebrew/bin/mono` or `file:///C:/Program%20Files/mono/mono.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1497
|
+
},
|
|
1498
|
+
"notarytool": {
|
|
1499
|
+
"anyOf": [
|
|
1500
|
+
{
|
|
1501
|
+
"items": {
|
|
1502
|
+
"type": "string"
|
|
1503
|
+
},
|
|
1504
|
+
"type": "array"
|
|
1505
|
+
},
|
|
1506
|
+
{
|
|
1507
|
+
"type": [
|
|
1508
|
+
"null",
|
|
1509
|
+
"string"
|
|
1510
|
+
]
|
|
1511
|
+
}
|
|
1512
|
+
],
|
|
1513
|
+
"description": "One file:// URI, or a list of them, of the `notarytool` executable on the build machine, such as `file:///opt/homebrew/bin/notarytool` or `file:///C:/Program%20Files/notarytool/notarytool.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1514
|
+
},
|
|
1515
|
+
"pkgbuild": {
|
|
1516
|
+
"anyOf": [
|
|
1517
|
+
{
|
|
1518
|
+
"items": {
|
|
1519
|
+
"type": "string"
|
|
1520
|
+
},
|
|
1521
|
+
"type": "array"
|
|
1522
|
+
},
|
|
1523
|
+
{
|
|
1524
|
+
"type": [
|
|
1525
|
+
"null",
|
|
1526
|
+
"string"
|
|
1527
|
+
]
|
|
1528
|
+
}
|
|
1529
|
+
],
|
|
1530
|
+
"description": "One file:// URI, or a list of them, of the `pkgbuild` executable on the build machine, such as `file:///opt/homebrew/bin/pkgbuild` or `file:///C:/Program%20Files/pkgbuild/pkgbuild.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1531
|
+
},
|
|
1532
|
+
"pkgutil": {
|
|
1533
|
+
"anyOf": [
|
|
1534
|
+
{
|
|
1535
|
+
"items": {
|
|
1536
|
+
"type": "string"
|
|
1537
|
+
},
|
|
1538
|
+
"type": "array"
|
|
1539
|
+
},
|
|
1540
|
+
{
|
|
1541
|
+
"type": [
|
|
1542
|
+
"null",
|
|
1543
|
+
"string"
|
|
1544
|
+
]
|
|
1545
|
+
}
|
|
1546
|
+
],
|
|
1547
|
+
"description": "One file:// URI, or a list of them, of the `pkgutil` executable on the build machine, such as `file:///opt/homebrew/bin/pkgutil` or `file:///C:/Program%20Files/pkgutil/pkgutil.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1548
|
+
},
|
|
1549
|
+
"powershell": {
|
|
1550
|
+
"anyOf": [
|
|
1551
|
+
{
|
|
1552
|
+
"items": {
|
|
1553
|
+
"type": "string"
|
|
1554
|
+
},
|
|
1555
|
+
"type": "array"
|
|
1556
|
+
},
|
|
1557
|
+
{
|
|
1558
|
+
"type": [
|
|
1559
|
+
"null",
|
|
1560
|
+
"string"
|
|
1561
|
+
]
|
|
1562
|
+
}
|
|
1563
|
+
],
|
|
1564
|
+
"description": "One file:// URI, or a list of them, of the `powershell` executable on the build machine, such as `file:///opt/homebrew/bin/powershell` or `file:///C:/Program%20Files/powershell/powershell.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1565
|
+
},
|
|
1566
|
+
"prlctl": {
|
|
1567
|
+
"anyOf": [
|
|
1568
|
+
{
|
|
1569
|
+
"items": {
|
|
1570
|
+
"type": "string"
|
|
1571
|
+
},
|
|
1572
|
+
"type": "array"
|
|
1573
|
+
},
|
|
1574
|
+
{
|
|
1575
|
+
"type": [
|
|
1576
|
+
"null",
|
|
1577
|
+
"string"
|
|
1578
|
+
]
|
|
1579
|
+
}
|
|
1580
|
+
],
|
|
1581
|
+
"description": "One file:// URI, or a list of them, of the `prlctl` executable on the build machine, such as `file:///opt/homebrew/bin/prlctl` or `file:///C:/Program%20Files/prlctl/prlctl.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1582
|
+
},
|
|
1583
|
+
"productbuild": {
|
|
1584
|
+
"anyOf": [
|
|
1585
|
+
{
|
|
1586
|
+
"items": {
|
|
1587
|
+
"type": "string"
|
|
1588
|
+
},
|
|
1589
|
+
"type": "array"
|
|
1590
|
+
},
|
|
1591
|
+
{
|
|
1592
|
+
"type": [
|
|
1593
|
+
"null",
|
|
1594
|
+
"string"
|
|
1595
|
+
]
|
|
1596
|
+
}
|
|
1597
|
+
],
|
|
1598
|
+
"description": "One file:// URI, or a list of them, of the `productbuild` executable on the build machine, such as `file:///opt/homebrew/bin/productbuild` or `file:///C:/Program%20Files/productbuild/productbuild.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1599
|
+
},
|
|
1600
|
+
"pwsh": {
|
|
1601
|
+
"anyOf": [
|
|
1602
|
+
{
|
|
1603
|
+
"items": {
|
|
1604
|
+
"type": "string"
|
|
1605
|
+
},
|
|
1606
|
+
"type": "array"
|
|
1607
|
+
},
|
|
1608
|
+
{
|
|
1609
|
+
"type": [
|
|
1610
|
+
"null",
|
|
1611
|
+
"string"
|
|
1612
|
+
]
|
|
1613
|
+
}
|
|
1614
|
+
],
|
|
1615
|
+
"description": "One file:// URI, or a list of them, of the `pwsh` executable on the build machine, such as `file:///opt/homebrew/bin/pwsh` or `file:///C:/Program%20Files/pwsh/pwsh.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1616
|
+
},
|
|
1617
|
+
"sips": {
|
|
1618
|
+
"anyOf": [
|
|
1619
|
+
{
|
|
1620
|
+
"items": {
|
|
1621
|
+
"type": "string"
|
|
1622
|
+
},
|
|
1623
|
+
"type": "array"
|
|
1624
|
+
},
|
|
1625
|
+
{
|
|
1626
|
+
"type": [
|
|
1627
|
+
"null",
|
|
1628
|
+
"string"
|
|
1629
|
+
]
|
|
1630
|
+
}
|
|
1631
|
+
],
|
|
1632
|
+
"description": "One file:// URI, or a list of them, of the `sips` executable on the build machine, such as `file:///opt/homebrew/bin/sips` or `file:///C:/Program%20Files/sips/sips.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1633
|
+
},
|
|
1634
|
+
"snapcraft": {
|
|
1635
|
+
"anyOf": [
|
|
1636
|
+
{
|
|
1637
|
+
"items": {
|
|
1638
|
+
"type": "string"
|
|
1639
|
+
},
|
|
1640
|
+
"type": "array"
|
|
1641
|
+
},
|
|
1642
|
+
{
|
|
1643
|
+
"type": [
|
|
1644
|
+
"null",
|
|
1645
|
+
"string"
|
|
1646
|
+
]
|
|
1647
|
+
}
|
|
1648
|
+
],
|
|
1649
|
+
"description": "One file:// URI, or a list of them, of the `snapcraft` executable on the build machine, such as `file:///opt/homebrew/bin/snapcraft` or `file:///C:/Program%20Files/snapcraft/snapcraft.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1650
|
+
},
|
|
1651
|
+
"stapler": {
|
|
1652
|
+
"anyOf": [
|
|
1653
|
+
{
|
|
1654
|
+
"items": {
|
|
1655
|
+
"type": "string"
|
|
1656
|
+
},
|
|
1657
|
+
"type": "array"
|
|
1658
|
+
},
|
|
1659
|
+
{
|
|
1660
|
+
"type": [
|
|
1661
|
+
"null",
|
|
1662
|
+
"string"
|
|
1663
|
+
]
|
|
1664
|
+
}
|
|
1665
|
+
],
|
|
1666
|
+
"description": "One file:// URI, or a list of them, of the `stapler` executable on the build machine, such as `file:///opt/homebrew/bin/stapler` or `file:///C:/Program%20Files/stapler/stapler.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1667
|
+
},
|
|
1668
|
+
"tiffutil": {
|
|
1669
|
+
"anyOf": [
|
|
1670
|
+
{
|
|
1671
|
+
"items": {
|
|
1672
|
+
"type": "string"
|
|
1673
|
+
},
|
|
1674
|
+
"type": "array"
|
|
1675
|
+
},
|
|
1676
|
+
{
|
|
1677
|
+
"type": [
|
|
1678
|
+
"null",
|
|
1679
|
+
"string"
|
|
1680
|
+
]
|
|
1681
|
+
}
|
|
1682
|
+
],
|
|
1683
|
+
"description": "One file:// URI, or a list of them, of the `tiffutil` executable on the build machine, such as `file:///opt/homebrew/bin/tiffutil` or `file:///C:/Program%20Files/tiffutil/tiffutil.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1684
|
+
},
|
|
1685
|
+
"wine": {
|
|
1686
|
+
"anyOf": [
|
|
1687
|
+
{
|
|
1688
|
+
"items": {
|
|
1689
|
+
"type": "string"
|
|
1690
|
+
},
|
|
1691
|
+
"type": "array"
|
|
1692
|
+
},
|
|
1693
|
+
{
|
|
1694
|
+
"type": [
|
|
1695
|
+
"null",
|
|
1696
|
+
"string"
|
|
1697
|
+
]
|
|
1698
|
+
}
|
|
1699
|
+
],
|
|
1700
|
+
"description": "One file:// URI, or a list of them, of the `wine` executable on the build machine, such as `file:///opt/homebrew/bin/wine` or `file:///C:/Program%20Files/wine/wine.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1701
|
+
},
|
|
1702
|
+
"zip": {
|
|
1703
|
+
"anyOf": [
|
|
1704
|
+
{
|
|
1705
|
+
"items": {
|
|
1706
|
+
"type": "string"
|
|
1707
|
+
},
|
|
1708
|
+
"type": "array"
|
|
1709
|
+
},
|
|
1710
|
+
{
|
|
1711
|
+
"type": [
|
|
1712
|
+
"null",
|
|
1713
|
+
"string"
|
|
1714
|
+
]
|
|
1715
|
+
}
|
|
1716
|
+
],
|
|
1717
|
+
"description": "One file:// URI, or a list of them, of the `zip` executable on the build machine, such as `file:///opt/homebrew/bin/zip` or `file:///C:/Program%20Files/zip/zip.exe`. The first that is an executable file is used; a URI with a Windows drive letter is skipped on macOS and Linux, and one without it on Windows. Plain paths, `~` and URIs that name another host are not accepted. Unset or `null` uses the default locations."
|
|
1718
|
+
}
|
|
1719
|
+
},
|
|
1720
|
+
"type": "object"
|
|
1721
|
+
},
|
|
1353
1722
|
"FileAssociation": {
|
|
1354
1723
|
"additionalProperties": false,
|
|
1355
1724
|
"description": "File associations.\n\nmacOS (corresponds to [CFBundleDocumentTypes](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-101685)), NSIS, and MSI only.\n\nOn Windows (NSIS) works only if [nsis.perMachine](https://www.electron.build/nsis) is set to `true`.",
|
|
@@ -1446,7 +1815,7 @@
|
|
|
1446
1815
|
},
|
|
1447
1816
|
"FilesBuildOptions": {
|
|
1448
1817
|
"additionalProperties": false,
|
|
1449
|
-
"description": "Which files are copied into the packaged app, which file extensions are excluded from it, and which symlinks among them may lead outside it,\nset under `fileOptions` at the configuration root or per platform (e.g. `mac.fileOptions`). A platform's file lists are added to the root\nones; a platform's `excludedExts` and `allowExternalLinks` replace the root ones.\nSee [file options](https://www.electron.build/docs/migration/v27-
|
|
1818
|
+
"description": "Which files are copied into the packaged app, which file extensions are excluded from it, and which symlinks among them may lead outside it,\nset under `fileOptions` at the configuration root or per platform (e.g. `mac.fileOptions`). A platform's file lists are added to the root\nones; a platform's `excludedExts` and `allowExternalLinks` replace the root ones.\nSee [file options](https://www.electron.build/docs/migration/v27-config-changes#file-options-fileoptions).",
|
|
1450
1819
|
"properties": {
|
|
1451
1820
|
"allowExternalLinks": {
|
|
1452
1821
|
"anyOf": [
|
|
@@ -1977,6 +2346,17 @@
|
|
|
1977
2346
|
"useMultipleRangeRequest": {
|
|
1978
2347
|
"description": "Whether to use multiple range requests for differential update. Defaults to `true` if `url` doesn't contain `s3.amazonaws.com`.",
|
|
1979
2348
|
"type": "boolean"
|
|
2349
|
+
},
|
|
2350
|
+
"verifyUpdateCodeSignature": {
|
|
2351
|
+
"anyOf": [
|
|
2352
|
+
{
|
|
2353
|
+
"const": false,
|
|
2354
|
+
"type": "boolean"
|
|
2355
|
+
},
|
|
2356
|
+
{
|
|
2357
|
+
"type": "null"
|
|
2358
|
+
}
|
|
2359
|
+
]
|
|
1980
2360
|
}
|
|
1981
2361
|
},
|
|
1982
2362
|
"required": [
|
|
@@ -2128,6 +2508,17 @@
|
|
|
2128
2508
|
"null",
|
|
2129
2509
|
"string"
|
|
2130
2510
|
]
|
|
2511
|
+
},
|
|
2512
|
+
"verifyUpdateCodeSignature": {
|
|
2513
|
+
"anyOf": [
|
|
2514
|
+
{
|
|
2515
|
+
"const": false,
|
|
2516
|
+
"type": "boolean"
|
|
2517
|
+
},
|
|
2518
|
+
{
|
|
2519
|
+
"type": "null"
|
|
2520
|
+
}
|
|
2521
|
+
]
|
|
2131
2522
|
}
|
|
2132
2523
|
},
|
|
2133
2524
|
"required": [
|
|
@@ -2248,6 +2639,17 @@
|
|
|
2248
2639
|
"default": true,
|
|
2249
2640
|
"description": "Whether to use `v`-prefixed tag name.",
|
|
2250
2641
|
"type": "boolean"
|
|
2642
|
+
},
|
|
2643
|
+
"verifyUpdateCodeSignature": {
|
|
2644
|
+
"anyOf": [
|
|
2645
|
+
{
|
|
2646
|
+
"const": false,
|
|
2647
|
+
"type": "boolean"
|
|
2648
|
+
},
|
|
2649
|
+
{
|
|
2650
|
+
"type": "null"
|
|
2651
|
+
}
|
|
2652
|
+
]
|
|
2251
2653
|
}
|
|
2252
2654
|
},
|
|
2253
2655
|
"required": [
|
|
@@ -2355,6 +2757,17 @@
|
|
|
2355
2757
|
"null",
|
|
2356
2758
|
"string"
|
|
2357
2759
|
]
|
|
2760
|
+
},
|
|
2761
|
+
"verifyUpdateCodeSignature": {
|
|
2762
|
+
"anyOf": [
|
|
2763
|
+
{
|
|
2764
|
+
"const": false,
|
|
2765
|
+
"type": "boolean"
|
|
2766
|
+
},
|
|
2767
|
+
{
|
|
2768
|
+
"type": "null"
|
|
2769
|
+
}
|
|
2770
|
+
]
|
|
2358
2771
|
}
|
|
2359
2772
|
},
|
|
2360
2773
|
"required": [
|
|
@@ -2529,7 +2942,7 @@
|
|
|
2529
2942
|
},
|
|
2530
2943
|
"forceCodeSigning": {
|
|
2531
2944
|
"default": false,
|
|
2532
|
-
"description": "
|
|
2945
|
+
"description": "Overrides the root `forceCodeSigning` for this platform: whether to fail the build if the app could not be code-signed,\nnotarized, or have its auto-update manifests signed, and to verify the signatures it produces. See the root option for\nwhat is enforced. Mac App Store builds cascade `mac` → `mas` (→ `masDev` for `mas-dev`), like every other option, so `mas.forceCodeSigning` / `masDev.forceCodeSigning` apply to their targets only.",
|
|
2533
2946
|
"type": "boolean"
|
|
2534
2947
|
},
|
|
2535
2948
|
"generateUpdatesFilesForAllChannels": {
|
|
@@ -2680,7 +3093,7 @@
|
|
|
2680
3093
|
"type": "null"
|
|
2681
3094
|
}
|
|
2682
3095
|
],
|
|
2683
|
-
"description": "Ed25519 signing of the auto-update manifest (`latest*.yml`). Each manifest is signed and its public key is\nembedded into `app-update.yml`, so electron-updater verifies the signature before downloading an update.\n\n**Signing is required.** Publishing a build that emits auto-update metadata fails unless a signing key\nresolves. Generate one once with `electron-builder create-update-key`, then supply it via\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` (the PEM file, base64-encoded) / `ELECTRON_BUILDER_UPDATE_SIGN_KEY_FILE` (its path),\npreferred in CI, or via `signingKey` / `signingKeyFile` below. Leaving this option unset — or `null` — keeps signing required and\nresolves the key from the environment; `null` is not an opt-out.\n\nSet to `false`, the only opt-out, to ship **unsigned** manifests. Every build that produces a manifest then\nlogs a warning. `false` also short-circuits the environment variables, so a leftover\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` in CI cannot re-enable signing by accident.\n\nThe requirement is
|
|
3096
|
+
"description": "Ed25519 signing of the auto-update manifest (`latest*.yml`). Each manifest is signed and its public key is\nembedded into `app-update.yml`, so electron-updater verifies the signature before downloading an update.\n\n**Signing is required.** Publishing a build that emits auto-update metadata fails unless a signing key\nresolves. Generate one once with `electron-builder create-update-key`, then supply it via\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` (the PEM file, base64-encoded) / `ELECTRON_BUILDER_UPDATE_SIGN_KEY_FILE` (its path),\npreferred in CI, or via `signingKey` / `signingKeyFile` below. Leaving this option unset — or `null` — keeps signing required and\nresolves the key from the environment; `null` is not an opt-out.\n\nSet to `false`, the only opt-out, to ship **unsigned** manifests. Every build that produces a manifest then\nlogs a warning. `false` also short-circuits the environment variables, so a leftover\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` in CI cannot re-enable signing by accident.\n\nThe requirement is enforced when a publish policy is in effect (`--publish`) or `forceCodeSigning` is set; any other\nbuild warns instead, so local builds and pipelines that sign the manifest in a later step of their own are\nunaffected. It is also waived when every publish provider has `publishAutoUpdate: false`, since no manifest is\nemitted then, and for a build whose targets write no update info (e.g. only snap, flatpak, MSI/MSIX, portable,\nmas/pkg or plain archives). A publishing (or `forceCodeSigning`) build checks for the key at build start, before\nanything is packed or uploaded. Every signed manifest is read back and verified before it is written.\n\nSee [Signed Update Manifests](https://www.electron.build/features/signed-update-manifests)."
|
|
2684
3097
|
},
|
|
2685
3098
|
"vendor": {
|
|
2686
3099
|
"description": "The vendor. Defaults to [author](https://www.electron.build/configuration#author).",
|
|
@@ -3128,7 +3541,7 @@
|
|
|
3128
3541
|
},
|
|
3129
3542
|
"forceCodeSigning": {
|
|
3130
3543
|
"default": false,
|
|
3131
|
-
"description": "
|
|
3544
|
+
"description": "Overrides the root `forceCodeSigning` for this platform: whether to fail the build if the app could not be code-signed,\nnotarized, or have its auto-update manifests signed, and to verify the signatures it produces. See the root option for\nwhat is enforced. Mac App Store builds cascade `mac` → `mas` (→ `masDev` for `mas-dev`), like every other option, so `mas.forceCodeSigning` / `masDev.forceCodeSigning` apply to their targets only.",
|
|
3132
3545
|
"type": "boolean"
|
|
3133
3546
|
},
|
|
3134
3547
|
"generateUpdatesFilesForAllChannels": {
|
|
@@ -3200,7 +3613,7 @@
|
|
|
3200
3613
|
]
|
|
3201
3614
|
},
|
|
3202
3615
|
"notarize": {
|
|
3203
|
-
"description": "Whether to
|
|
3616
|
+
"description": "Whether to notarize the app with [@electron/notarize](https://github.com/electron/notarize).\n\n- unset (the default): notarize when notarization credentials are set, otherwise skip it with a warning.\n- `true`: notarization is required: the build fails when no credentials are set, wherever notarization would run (a macOS host,\n outside a pull-request build, with signing not turned off), at build start and when notarizing.\n- `false`: never notarize (for an ad-hoc or development-signed app, or one notarized in an `afterSign` hook).\n\nThe credentials are one of the following sets of environment variables:\n\n1. `APPLE_API_KEY` (path to the `.p8` file, or its contents base64-encoded), `APPLE_API_KEY_ID` and `APPLE_API_ISSUER`.\n2. `APPLE_ID`, `APPLE_APP_SPECIFIC_PASSWORD`, and `APPLE_TEAM_ID`\n3. `APPLE_KEYCHAIN` and `APPLE_KEYCHAIN_PROFILE`\n\nFor security reasons it is recommended to use the first option (see https://github.com/electron-userland/electron-builder/issues/7859)",
|
|
3204
3617
|
"type": "boolean"
|
|
3205
3618
|
},
|
|
3206
3619
|
"protocols": {
|
|
@@ -3364,7 +3777,7 @@
|
|
|
3364
3777
|
"type": "null"
|
|
3365
3778
|
}
|
|
3366
3779
|
],
|
|
3367
|
-
"description": "Ed25519 signing of the auto-update manifest (`latest*.yml`). Each manifest is signed and its public key is\nembedded into `app-update.yml`, so electron-updater verifies the signature before downloading an update.\n\n**Signing is required.** Publishing a build that emits auto-update metadata fails unless a signing key\nresolves. Generate one once with `electron-builder create-update-key`, then supply it via\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` (the PEM file, base64-encoded) / `ELECTRON_BUILDER_UPDATE_SIGN_KEY_FILE` (its path),\npreferred in CI, or via `signingKey` / `signingKeyFile` below. Leaving this option unset — or `null` — keeps signing required and\nresolves the key from the environment; `null` is not an opt-out.\n\nSet to `false`, the only opt-out, to ship **unsigned** manifests. Every build that produces a manifest then\nlogs a warning. `false` also short-circuits the environment variables, so a leftover\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` in CI cannot re-enable signing by accident.\n\nThe requirement is
|
|
3780
|
+
"description": "Ed25519 signing of the auto-update manifest (`latest*.yml`). Each manifest is signed and its public key is\nembedded into `app-update.yml`, so electron-updater verifies the signature before downloading an update.\n\n**Signing is required.** Publishing a build that emits auto-update metadata fails unless a signing key\nresolves. Generate one once with `electron-builder create-update-key`, then supply it via\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` (the PEM file, base64-encoded) / `ELECTRON_BUILDER_UPDATE_SIGN_KEY_FILE` (its path),\npreferred in CI, or via `signingKey` / `signingKeyFile` below. Leaving this option unset — or `null` — keeps signing required and\nresolves the key from the environment; `null` is not an opt-out.\n\nSet to `false`, the only opt-out, to ship **unsigned** manifests. Every build that produces a manifest then\nlogs a warning. `false` also short-circuits the environment variables, so a leftover\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` in CI cannot re-enable signing by accident.\n\nThe requirement is enforced when a publish policy is in effect (`--publish`) or `forceCodeSigning` is set; any other\nbuild warns instead, so local builds and pipelines that sign the manifest in a later step of their own are\nunaffected. It is also waived when every publish provider has `publishAutoUpdate: false`, since no manifest is\nemitted then, and for a build whose targets write no update info (e.g. only snap, flatpak, MSI/MSIX, portable,\nmas/pkg or plain archives). A publishing (or `forceCodeSigning`) build checks for the key at build start, before\nanything is packed or uploaded. Every signed manifest is read back and verified before it is written.\n\nSee [Signed Update Manifests](https://www.electron.build/features/signed-update-manifests)."
|
|
3368
3781
|
}
|
|
3369
3782
|
},
|
|
3370
3783
|
"type": "object"
|
|
@@ -3558,7 +3971,7 @@
|
|
|
3558
3971
|
},
|
|
3559
3972
|
"forceCodeSigning": {
|
|
3560
3973
|
"default": false,
|
|
3561
|
-
"description": "
|
|
3974
|
+
"description": "Overrides the root `forceCodeSigning` for this platform: whether to fail the build if the app could not be code-signed,\nnotarized, or have its auto-update manifests signed, and to verify the signatures it produces. See the root option for\nwhat is enforced. Mac App Store builds cascade `mac` → `mas` (→ `masDev` for `mas-dev`), like every other option, so `mas.forceCodeSigning` / `masDev.forceCodeSigning` apply to their targets only.",
|
|
3562
3975
|
"type": "boolean"
|
|
3563
3976
|
},
|
|
3564
3977
|
"generateUpdatesFilesForAllChannels": {
|
|
@@ -3630,7 +4043,7 @@
|
|
|
3630
4043
|
]
|
|
3631
4044
|
},
|
|
3632
4045
|
"notarize": {
|
|
3633
|
-
"description": "Whether to
|
|
4046
|
+
"description": "Whether to notarize the app with [@electron/notarize](https://github.com/electron/notarize).\n\n- unset (the default): notarize when notarization credentials are set, otherwise skip it with a warning.\n- `true`: notarization is required: the build fails when no credentials are set, wherever notarization would run (a macOS host,\n outside a pull-request build, with signing not turned off), at build start and when notarizing.\n- `false`: never notarize (for an ad-hoc or development-signed app, or one notarized in an `afterSign` hook).\n\nThe credentials are one of the following sets of environment variables:\n\n1. `APPLE_API_KEY` (path to the `.p8` file, or its contents base64-encoded), `APPLE_API_KEY_ID` and `APPLE_API_ISSUER`.\n2. `APPLE_ID`, `APPLE_APP_SPECIFIC_PASSWORD`, and `APPLE_TEAM_ID`\n3. `APPLE_KEYCHAIN` and `APPLE_KEYCHAIN_PROFILE`\n\nFor security reasons it is recommended to use the first option (see https://github.com/electron-userland/electron-builder/issues/7859)",
|
|
3634
4047
|
"type": "boolean"
|
|
3635
4048
|
},
|
|
3636
4049
|
"protocols": {
|
|
@@ -3794,7 +4207,7 @@
|
|
|
3794
4207
|
"type": "null"
|
|
3795
4208
|
}
|
|
3796
4209
|
],
|
|
3797
|
-
"description": "Ed25519 signing of the auto-update manifest (`latest*.yml`). Each manifest is signed and its public key is\nembedded into `app-update.yml`, so electron-updater verifies the signature before downloading an update.\n\n**Signing is required.** Publishing a build that emits auto-update metadata fails unless a signing key\nresolves. Generate one once with `electron-builder create-update-key`, then supply it via\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` (the PEM file, base64-encoded) / `ELECTRON_BUILDER_UPDATE_SIGN_KEY_FILE` (its path),\npreferred in CI, or via `signingKey` / `signingKeyFile` below. Leaving this option unset — or `null` — keeps signing required and\nresolves the key from the environment; `null` is not an opt-out.\n\nSet to `false`, the only opt-out, to ship **unsigned** manifests. Every build that produces a manifest then\nlogs a warning. `false` also short-circuits the environment variables, so a leftover\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` in CI cannot re-enable signing by accident.\n\nThe requirement is
|
|
4210
|
+
"description": "Ed25519 signing of the auto-update manifest (`latest*.yml`). Each manifest is signed and its public key is\nembedded into `app-update.yml`, so electron-updater verifies the signature before downloading an update.\n\n**Signing is required.** Publishing a build that emits auto-update metadata fails unless a signing key\nresolves. Generate one once with `electron-builder create-update-key`, then supply it via\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` (the PEM file, base64-encoded) / `ELECTRON_BUILDER_UPDATE_SIGN_KEY_FILE` (its path),\npreferred in CI, or via `signingKey` / `signingKeyFile` below. Leaving this option unset — or `null` — keeps signing required and\nresolves the key from the environment; `null` is not an opt-out.\n\nSet to `false`, the only opt-out, to ship **unsigned** manifests. Every build that produces a manifest then\nlogs a warning. `false` also short-circuits the environment variables, so a leftover\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` in CI cannot re-enable signing by accident.\n\nThe requirement is enforced when a publish policy is in effect (`--publish`) or `forceCodeSigning` is set; any other\nbuild warns instead, so local builds and pipelines that sign the manifest in a later step of their own are\nunaffected. It is also waived when every publish provider has `publishAutoUpdate: false`, since no manifest is\nemitted then, and for a build whose targets write no update info (e.g. only snap, flatpak, MSI/MSIX, portable,\nmas/pkg or plain archives). A publishing (or `forceCodeSigning`) build checks for the key at build start, before\nanything is packed or uploaded. Every signed manifest is read back and verified before it is written.\n\nSee [Signed Update Manifests](https://www.electron.build/features/signed-update-manifests)."
|
|
3798
4211
|
}
|
|
3799
4212
|
},
|
|
3800
4213
|
"type": "object"
|
|
@@ -6318,6 +6731,17 @@
|
|
|
6318
6731
|
"null",
|
|
6319
6732
|
"string"
|
|
6320
6733
|
]
|
|
6734
|
+
},
|
|
6735
|
+
"verifyUpdateCodeSignature": {
|
|
6736
|
+
"anyOf": [
|
|
6737
|
+
{
|
|
6738
|
+
"const": false,
|
|
6739
|
+
"type": "boolean"
|
|
6740
|
+
},
|
|
6741
|
+
{
|
|
6742
|
+
"type": "null"
|
|
6743
|
+
}
|
|
6744
|
+
]
|
|
6321
6745
|
}
|
|
6322
6746
|
},
|
|
6323
6747
|
"required": [
|
|
@@ -6929,6 +7353,17 @@
|
|
|
6929
7353
|
"null",
|
|
6930
7354
|
"string"
|
|
6931
7355
|
]
|
|
7356
|
+
},
|
|
7357
|
+
"verifyUpdateCodeSignature": {
|
|
7358
|
+
"anyOf": [
|
|
7359
|
+
{
|
|
7360
|
+
"const": false,
|
|
7361
|
+
"type": "boolean"
|
|
7362
|
+
},
|
|
7363
|
+
{
|
|
7364
|
+
"type": "null"
|
|
7365
|
+
}
|
|
7366
|
+
]
|
|
6932
7367
|
}
|
|
6933
7368
|
},
|
|
6934
7369
|
"required": [
|
|
@@ -7801,6 +8236,17 @@
|
|
|
7801
8236
|
"null",
|
|
7802
8237
|
"string"
|
|
7803
8238
|
]
|
|
8239
|
+
},
|
|
8240
|
+
"verifyUpdateCodeSignature": {
|
|
8241
|
+
"anyOf": [
|
|
8242
|
+
{
|
|
8243
|
+
"const": false,
|
|
8244
|
+
"type": "boolean"
|
|
8245
|
+
},
|
|
8246
|
+
{
|
|
8247
|
+
"type": "null"
|
|
8248
|
+
}
|
|
8249
|
+
]
|
|
7804
8250
|
}
|
|
7805
8251
|
},
|
|
7806
8252
|
"required": [
|
|
@@ -8295,6 +8741,17 @@
|
|
|
8295
8741
|
"null",
|
|
8296
8742
|
"string"
|
|
8297
8743
|
]
|
|
8744
|
+
},
|
|
8745
|
+
"verifyUpdateCodeSignature": {
|
|
8746
|
+
"anyOf": [
|
|
8747
|
+
{
|
|
8748
|
+
"const": false,
|
|
8749
|
+
"type": "boolean"
|
|
8750
|
+
},
|
|
8751
|
+
{
|
|
8752
|
+
"type": "null"
|
|
8753
|
+
}
|
|
8754
|
+
]
|
|
8298
8755
|
}
|
|
8299
8756
|
},
|
|
8300
8757
|
"required": [
|
|
@@ -8329,7 +8786,7 @@
|
|
|
8329
8786
|
]
|
|
8330
8787
|
},
|
|
8331
8788
|
"msi": {
|
|
8332
|
-
"description": "Whether to create an MSI installer. Defaults to `false` (MSI is not created).",
|
|
8789
|
+
"description": "Whether to create an MSI installer. Defaults to `false` (MSI is not created).\n\nSquirrel.Windows builds the MSI around Setup.exe before electron-builder signs Setup.exe, so the installer inside the MSI is\nunsigned: the build warns, and fails with `forceCodeSigning`. For a signed MSI use the `msi` target instead.",
|
|
8333
8790
|
"type": "boolean"
|
|
8334
8791
|
},
|
|
8335
8792
|
"name": {
|
|
@@ -8460,6 +8917,18 @@
|
|
|
8460
8917
|
"default": "latest",
|
|
8461
8918
|
"description": "Version of the AppImage toolset bundle used for building `.AppImage` files.\n\nThe bundle ships:\n- **`mksquashfs`** — creates the SquashFS filesystem embedded in the AppImage. It also packs legacy-base (core18/core20/core22) snaps built from the snap template app.\n- **`desktop-file-validate`** — validates the generated `.desktop` entry.\n- **AppImage runtime** — the self-executing stub that mounts the SquashFS at launch.\n\nAvailable versions:\n| Version | Runtime date | Notes |\n|---------|-------------|-------|\n| `\"0.0.0\"` | Legacy | FUSE2-based AppImage runtime (pre-v27) |\n| `\"1.0.3\"` | 20251108 | Introduces static AppImage runtime |\n| `\"1.1.0\"` | 20251108 | Adds `unsquashfs` support |\n\nAn explicit version pin always selects exactly that release.\n\nReleases: https://github.com/electron-userland/electron-builder-binaries/blob/master/packages/appimage/CHANGELOG.md"
|
|
8462
8919
|
},
|
|
8920
|
+
"executables": {
|
|
8921
|
+
"anyOf": [
|
|
8922
|
+
{
|
|
8923
|
+
"$ref": "#/definitions/ExecutablesConfig",
|
|
8924
|
+
"description": "The locations of host programs, by {@link ExecutableName}. An unset or `null` entry uses the built-in default locations."
|
|
8925
|
+
},
|
|
8926
|
+
{
|
|
8927
|
+
"type": "null"
|
|
8928
|
+
}
|
|
8929
|
+
],
|
|
8930
|
+
"description": "Where the host programs that electron-builder starts are installed on the build machine, by program name.\n\nelectron-builder starts these programs only from an absolute path, never by looking up a name on `PATH`. For each one it\nuses the first location that is an executable file: from this entry when it is set, otherwise from a built-in list of\ndefault install locations for the host operating system (see https://www.electron.build/docs/toolsets#executables).\nAn entry replaces the default list for that program; it is not merged with it."
|
|
8931
|
+
},
|
|
8463
8932
|
"fpm": {
|
|
8464
8933
|
"anyOf": [
|
|
8465
8934
|
{
|
|
@@ -8597,7 +9066,7 @@
|
|
|
8597
9066
|
}
|
|
8598
9067
|
],
|
|
8599
9068
|
"default": "latest",
|
|
8600
|
-
"description": "Version of the Wine bundle used to run Windows tools (NSIS, rcedit, signtool) on\nnon-Windows hosts (macOS and Linux).\n\nWine is only required when building Windows targets on a non-Windows machine. On Windows,\nthis setting has no effect.\n\nAvailable versions:\n| Version | Wine version | Platform support | Notes |\n|---------|-------------|-----------------|-------|\n| `\"0.0.0\"` | 4.0.1 | macOS | Legacy portable bundle (pre-v27) |\n| `\"1.0.1\"` | 11.0 | macOS | Supports arm64 macOS via Rosetta |\n| `\"system\"` | host install | macOS, Linux | Uses the
|
|
9069
|
+
"description": "Version of the Wine bundle used to run Windows tools (NSIS, rcedit, signtool) on\nnon-Windows hosts (macOS and Linux).\n\nWine is only required when building Windows targets on a non-Windows machine. On Windows,\nthis setting has no effect.\n\nAvailable versions:\n| Version | Wine version | Platform support | Notes |\n|---------|-------------|-----------------|-------|\n| `\"0.0.0\"` | 4.0.1 | macOS | Legacy portable bundle (pre-v27) |\n| `\"1.0.1\"` | 11.0 | macOS | Supports arm64 macOS via Rosetta |\n| `\"system\"` | host install | macOS, Linux | Uses the host Wine at a fixed install location instead of a bundle |\n\n`\"system\"` is the replacement for the `USE_SYSTEM_WINE` environment variable removed in v27, and\nis what `\"latest\"` (the default) currently resolves to on every platform: the published `\"1.0.1\"`\nbundles ship no PE builtins, so a host Wine installation is required to build Windows targets on\nmacOS or Linux.\n\nThe host Wine (`\"system\"`) is started by absolute path, never looked up on `PATH`: it is the `wine` entry of\n{@link executables}, which lists its default install locations and is where a Wine installed elsewhere is set.\nSetting both a bundle that would be used (a `ToolsetCustom` object, or a version on macOS; on Linux a version selects no\nbundle) and `executables.wine` is a configuration error.\n\nTo use a custom Wine bundle, use a `ToolsetCustom` object.\n\nReleases: https://github.com/electron-userland/electron-builder-binaries/blob/master/packages/wine/CHANGELOG.md"
|
|
8601
9070
|
}
|
|
8602
9071
|
},
|
|
8603
9072
|
"type": "object"
|
|
@@ -8629,7 +9098,7 @@
|
|
|
8629
9098
|
"properties": {
|
|
8630
9099
|
"allowSigningKeyOutsideTrustList": {
|
|
8631
9100
|
"default": false,
|
|
8632
|
-
"description": "Allows a publishing build to sign its manifests only with keys that are not in `publicKey` - a deliberate\ncutover release that is verified by installs with the old key, but hands them over to the keys listed in\n`publicKey`. Every later release must then be signed by a listed key. Without it such a build fails; a build\nwithout a publish policy only warns. Has no effect when `publicKey` is not set.",
|
|
9101
|
+
"description": "Allows a publishing build to sign its manifests only with keys that are not in `publicKey` - a deliberate\ncutover release that is verified by installs with the old key, but hands them over to the keys listed in\n`publicKey`. Every later release must then be signed by a listed key. Without it such a build fails; a build\nwithout a publish policy or `forceCodeSigning` only warns. Has no effect when `publicKey` is not set.",
|
|
8633
9102
|
"type": [
|
|
8634
9103
|
"null",
|
|
8635
9104
|
"boolean"
|
|
@@ -8650,7 +9119,7 @@
|
|
|
8650
9119
|
]
|
|
8651
9120
|
}
|
|
8652
9121
|
],
|
|
8653
|
-
"description": "The Ed25519 public key(s) (PEM or base64 SPKI) embedded into `app-update.yml` as the updater's trust list.\nThe updater accepts a manifest when any listed key validates one of its signatures. Optional — when\nomitted the public key of every configured signing key is derived and embedded. Set it explicitly to trust\nadditional keys ahead of a rotation (for example `[current, next]`).\n\nA `publicKey` on its own does not satisfy the signing requirement — electron-builder still has no key to\nsign with. An external signer (HSM/KMS) that signs `latest*.yml` in a later step therefore either builds\nwithout a publish policy
|
|
9122
|
+
"description": "The Ed25519 public key(s) (PEM or base64 SPKI) embedded into `app-update.yml` as the updater's trust list.\nThe updater accepts a manifest when any listed key validates one of its signatures. Optional — when\nomitted the public key of every configured signing key is derived and embedded. Set it explicitly to trust\nadditional keys ahead of a rotation (for example `[current, next]`).\n\nA `publicKey` on its own does not satisfy the signing requirement — electron-builder still has no key to\nsign with. An external signer (HSM/KMS) that signs `latest*.yml` in a later step therefore either builds\nwithout a publish policy and without `forceCodeSigning`, where the requirement only warns and the unsigned\nmanifest is written locally, or keeps publishing with `publishAutoUpdate: false` on every publish provider -\nelectron-builder then uploads the artifacts and embeds this key, but writes no `latest*.yml`, so the external\nstep has to produce it too.\n\nWhen set, it must contain at least one of the signing keys: a publishing (or `forceCodeSigning`) build signed only by\nkeys outside this list fails, since its installs would reject manifests signed with them. See `allowSigningKeyOutsideTrustList`."
|
|
8654
9123
|
},
|
|
8655
9124
|
"signingKey": {
|
|
8656
9125
|
"anyOf": [
|
|
@@ -8715,7 +9184,7 @@
|
|
|
8715
9184
|
"type": "string"
|
|
8716
9185
|
},
|
|
8717
9186
|
"publisherName": {
|
|
8718
|
-
"description": "The publisher name to associate with the signature
|
|
9187
|
+
"description": "The publisher name to associate with the signature: a Distinguished Name (DN) of the subject of\nthe certificate issued by your Trusted Signing certificate profile (e.g.\n`CN=My Company, O=My Company, C=US`). Required. Used for\n[update verification](#verifyUpdateCodeSignature) (embedded in `app-update.yml` and checked by\nelectron-updater) and must match the certificate subject. A bare name fails the build since\nv27 — see\n[the migration guide](https://www.electron.build/docs/migration/v27-build-changes#windows-publishername-must-be-a-distinguished-name).",
|
|
8719
9188
|
"type": "string"
|
|
8720
9189
|
},
|
|
8721
9190
|
"timestampDigest": {
|
|
@@ -8746,6 +9215,11 @@
|
|
|
8746
9215
|
"WindowsConfiguration": {
|
|
8747
9216
|
"additionalProperties": false,
|
|
8748
9217
|
"properties": {
|
|
9218
|
+
"allowCatalogSignature": {
|
|
9219
|
+
"default": false,
|
|
9220
|
+
"description": "Whether electron-updater accepts an update installer whose signature Windows reports from a security catalog (a signed list of\nfile hashes) instead of one embedded in the installer — for update installers that are catalog-signed on purpose, such as an\nenterprise deployment that adds their hashes to a catalog. The catalog signer must still match the [publisher name](#publisherName).\n\nWhen `true`, the `latest.yml` written for the `nsis` and `nsis-web` targets carries `allowCatalogSignature: true`. electron-updater\nhonors it only when the [signature of that update manifest](https://www.electron.build/docs/features/signed-update-manifests)\nwas verified against a trusted key; in an unsigned manifest (or one signed by an untrusted key) it is ignored with a warning, and\ncatalog signatures stay rejected unless the app sets `autoUpdater.allowCatalogSignature = true`. Since it is covered by the manifest\nsignature, changing it for a published release means signing `latest.yml` again or republishing it.\n\nInstalls running electron-updater 7.0.0-alpha.8 to alpha.11 with an update key configured reject a signed manifest that sets it\n(`ERR_UPDATER_MANIFEST_SIGNATURE_INVALID`).",
|
|
9221
|
+
"type": "boolean"
|
|
9222
|
+
},
|
|
8749
9223
|
"appId": {
|
|
8750
9224
|
"default": "com.electron.${name}",
|
|
8751
9225
|
"description": "The application id. Used as [CFBundleIdentifier](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/20001431-102070) for MacOS and as\n[Application User Model ID](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx) for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.",
|
|
@@ -8869,7 +9343,7 @@
|
|
|
8869
9343
|
},
|
|
8870
9344
|
"forceCodeSigning": {
|
|
8871
9345
|
"default": false,
|
|
8872
|
-
"description": "
|
|
9346
|
+
"description": "Overrides the root `forceCodeSigning` for this platform: whether to fail the build if the app could not be code-signed,\nnotarized, or have its auto-update manifests signed, and to verify the signatures it produces. See the root option for\nwhat is enforced. Mac App Store builds cascade `mac` → `mas` (→ `masDev` for `mas-dev`), like every other option, so `mas.forceCodeSigning` / `masDev.forceCodeSigning` apply to their targets only.",
|
|
8873
9347
|
"type": "boolean"
|
|
8874
9348
|
},
|
|
8875
9349
|
"generateUpdatesFilesForAllChannels": {
|
|
@@ -8996,7 +9470,7 @@
|
|
|
8996
9470
|
"type": "null"
|
|
8997
9471
|
}
|
|
8998
9472
|
],
|
|
8999
|
-
"description": "Code signing configuration. Code signing stamps every installer and executable\nelectron-builder produces with an Authenticode signature, so that Windows (SmartScreen / UAC)\nand your auto-updater can verify the publisher and that the files were not tampered with.\n\nHow this option behaves:\n- Leave **unset** to sign using credentials discovered from the environment — primarily a\n certificate supplied via `WIN_CSC_LINK` (or `CSC_LINK`) with its password in\n `WIN_CSC_KEY_PASSWORD` (or `CSC_KEY_PASSWORD`). `WIN_CSC_LINK` accepts a file path, an\n `https://` URL, or a base64-encoded certificate. This is the recommended setup for CI.\n- Set to `false` or `null` to **disable** code signing entirely (executable resources such as\n the icon and metadata are still edited).\n- Set to an **object** to configure signing explicitly. The **required** `type` field selects the\n signing backend (`signtool`, `hsm`, `pkcs11`, or `azure`) and dispatches to a dedicated sign\n manager; provide exactly one of the modes below. When `win.sign` is left unset, the `signtool`\n backend is used with env-discovered credentials. Each output artifact is signed individually,\n and by default executables are dual-signed (see `signingHashAlgorithms`).\n\n- `{ type: \"signtool\", ... }` — Sign with a local certificate file (.pfx/.p12) or a\n certificate from the Windows certificate store. Uses Microsoft `signtool.exe` on Windows and\n `osslsigncode` on macOS/Linux.\n- `{ type: \"hsm\", ... }` — Sign using a Hardware Security Module (HSM) or FIPS-compliant\n hardware token via signtool's `/csp` (cryptographic service provider) and `/kc` (key\n container) flags. Requires a modern `winCodeSign` toolset (the default — only the legacy\n `\"0.0.0\"` pin is unsupported). Windows-only.\n- `{ type: \"pkcs11\", ... }` — Sign using a PKCS#11 hardware token via osslsigncode.\n Available on macOS and Linux CI without a Windows VM.\n- `{ type: \"azure\", ... }` — Sign via Azure Trusted Signing (cloud service). Requires\n Azure Entra ID environment variables for authentication.\n\nSee [Code Signing](https://www.electron.build/docs/features/code-signing)."
|
|
9473
|
+
"description": "Code signing configuration. Code signing stamps every installer and executable\nelectron-builder produces with an Authenticode signature, so that Windows (SmartScreen / UAC)\nand your auto-updater can verify the publisher and that the files were not tampered with.\n\nHow this option behaves:\n- Leave **unset** to sign using credentials discovered from the environment — primarily a\n certificate supplied via `WIN_CSC_LINK` (or `CSC_LINK`) with its password in\n `WIN_CSC_KEY_PASSWORD` (or `CSC_KEY_PASSWORD`). `WIN_CSC_LINK` accepts a file path, an\n `https://` URL, or a base64-encoded certificate. This is the recommended setup for CI.\n- Set to `false` or `null` to **disable** code signing entirely (executable resources such as\n the icon and metadata are still edited). A build that writes `app-update.yml` then also needs\n [verifyUpdateCodeSignature](#verifyUpdateCodeSignature) set to `false`, since no publisher\n name is derived; if you sign outside electron-builder, use `{ type: \"signtool\", publisherName: [...] }`\n instead.\n- Set to an **object** to configure signing explicitly. The **required** `type` field selects the\n signing backend (`signtool`, `hsm`, `pkcs11`, or `azure`) and dispatches to a dedicated sign\n manager; provide exactly one of the modes below. When `win.sign` is left unset, the `signtool`\n backend is used with env-discovered credentials. Each output artifact is signed individually,\n and by default executables are dual-signed (see `signingHashAlgorithms`).\n\n- `{ type: \"signtool\", ... }` — Sign with a local certificate file (.pfx/.p12) or a\n certificate from the Windows certificate store. Uses Microsoft `signtool.exe` on Windows and\n `osslsigncode` on macOS/Linux.\n- `{ type: \"hsm\", ... }` — Sign using a Hardware Security Module (HSM) or FIPS-compliant\n hardware token via signtool's `/csp` (cryptographic service provider) and `/kc` (key\n container) flags. Requires a modern `winCodeSign` toolset (the default — only the legacy\n `\"0.0.0\"` pin is unsupported). Windows-only.\n- `{ type: \"pkcs11\", ... }` — Sign using a PKCS#11 hardware token via osslsigncode.\n Available on macOS and Linux CI without a Windows VM.\n- `{ type: \"azure\", ... }` — Sign via Azure Trusted Signing (cloud service). Requires\n Azure Entra ID environment variables for authentication.\n\nSee [Code Signing](https://www.electron.build/docs/features/code-signing)."
|
|
9000
9474
|
},
|
|
9001
9475
|
"signExts": {
|
|
9002
9476
|
"anyOf": [
|
|
@@ -9053,11 +9527,11 @@
|
|
|
9053
9527
|
"type": "null"
|
|
9054
9528
|
}
|
|
9055
9529
|
],
|
|
9056
|
-
"description": "Ed25519 signing of the auto-update manifest (`latest*.yml`). Each manifest is signed and its public key is\nembedded into `app-update.yml`, so electron-updater verifies the signature before downloading an update.\n\n**Signing is required.** Publishing a build that emits auto-update metadata fails unless a signing key\nresolves. Generate one once with `electron-builder create-update-key`, then supply it via\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` (the PEM file, base64-encoded) / `ELECTRON_BUILDER_UPDATE_SIGN_KEY_FILE` (its path),\npreferred in CI, or via `signingKey` / `signingKeyFile` below. Leaving this option unset — or `null` — keeps signing required and\nresolves the key from the environment; `null` is not an opt-out.\n\nSet to `false`, the only opt-out, to ship **unsigned** manifests. Every build that produces a manifest then\nlogs a warning. `false` also short-circuits the environment variables, so a leftover\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` in CI cannot re-enable signing by accident.\n\nThe requirement is
|
|
9530
|
+
"description": "Ed25519 signing of the auto-update manifest (`latest*.yml`). Each manifest is signed and its public key is\nembedded into `app-update.yml`, so electron-updater verifies the signature before downloading an update.\n\n**Signing is required.** Publishing a build that emits auto-update metadata fails unless a signing key\nresolves. Generate one once with `electron-builder create-update-key`, then supply it via\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` (the PEM file, base64-encoded) / `ELECTRON_BUILDER_UPDATE_SIGN_KEY_FILE` (its path),\npreferred in CI, or via `signingKey` / `signingKeyFile` below. Leaving this option unset — or `null` — keeps signing required and\nresolves the key from the environment; `null` is not an opt-out.\n\nSet to `false`, the only opt-out, to ship **unsigned** manifests. Every build that produces a manifest then\nlogs a warning. `false` also short-circuits the environment variables, so a leftover\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` in CI cannot re-enable signing by accident.\n\nThe requirement is enforced when a publish policy is in effect (`--publish`) or `forceCodeSigning` is set; any other\nbuild warns instead, so local builds and pipelines that sign the manifest in a later step of their own are\nunaffected. It is also waived when every publish provider has `publishAutoUpdate: false`, since no manifest is\nemitted then, and for a build whose targets write no update info (e.g. only snap, flatpak, MSI/MSIX, portable,\nmas/pkg or plain archives). A publishing (or `forceCodeSigning`) build checks for the key at build start, before\nanything is packed or uploaded. Every signed manifest is read back and verified before it is written.\n\nSee [Signed Update Manifests](https://www.electron.build/features/signed-update-manifests)."
|
|
9057
9531
|
},
|
|
9058
9532
|
"verifyUpdateCodeSignature": {
|
|
9059
9533
|
"default": true,
|
|
9060
|
-
"description": "Whether the NSIS auto-updater should verify the Authenticode signature of a downloaded update\nbefore installing it. The verification itself runs in your app, via electron-updater.\n\nWhen enabled (the default), the resolved [publisher name](#publisherName) is embedded into\n`app-update.yml` at build time. At update time electron-updater inspects the certificate that\nsigned the downloaded installer and compares its subject (Distinguished Name
|
|
9534
|
+
"description": "Whether the NSIS auto-updater should verify the Authenticode signature of a downloaded update\nbefore installing it. The verification itself runs in your app, via electron-updater.\n\nWhen enabled (the default), the resolved [publisher name](#publisherName) is embedded into\n`app-update.yml` at build time. At update time electron-updater inspects the certificate that\nsigned the downloaded installer and compares its subject (Distinguished Name) against that\npublisher name, refusing to install on a mismatch or when the signature cannot be verified.\nThis prevents a tampered or maliciously substituted update from being installed.\n\nWhile enabled, electron-builder also checks at build time that the signed NSIS installer (or\nnsis-web stub) is signed by a certificate matching that publisher name, using the same matching\nrules, and fails the build otherwise.\n\nSince v27 a build that writes `app-update.yml` (an `nsis`, `nsis-web` or `electronUpdaterAware`\n`appx` target with a publish configuration) fails while this is enabled and no publisher name\nresolves (`sign: false` / `null`, no certificate, `publisherName: null`): electron-updater 7\nrejects every update of an app whose `app-update.yml` has no publisher name. Sign the build, set\n[publisherName](#publisherName), or set this to `false`.\n\nSet to `false` to skip verification explicitly — the publisher name is then **not** embedded, and\n`app-update.yml` carries `verifyUpdateCodeSignature: false` instead, which tells electron-updater\nto install updates without verifying their signature. This is the only opt-out.\nDisable this only if your updates are not Authenticode-signed.",
|
|
9061
9535
|
"type": "boolean"
|
|
9062
9536
|
}
|
|
9063
9537
|
},
|
|
@@ -9117,7 +9591,7 @@
|
|
|
9117
9591
|
]
|
|
9118
9592
|
}
|
|
9119
9593
|
],
|
|
9120
|
-
"description": "The publisher name(s) to associate with the signature, written
|
|
9594
|
+
"description": "The publisher name(s) to associate with the signature: a Distinguished Name (DN) of your code\nsigning certificate's subject, written with the attribute names Windows uses (e.g.\n`CN=My Company, O=My Company, C=US`). Every attribute you list must equal the certificate's;\nattributes you leave out are not compared. A bare name (`My Company`) fails the build since v27,\nbecause electron-updater 7 never matches it — see\n[the migration guide](https://www.electron.build/docs/migration/v27-build-changes#windows-publishername-must-be-a-distinguished-name).\nMay be a single string or an array — an array is useful when rotating certificates, so updates\nsigned by either the old or the new certificate still verify.\n\nThis value is not a `signtool` argument; it is consumed in two places:\n- **Update verification** — when [verifyUpdateCodeSignature](#verifyUpdateCodeSignature) is\n enabled, it is written into `app-update.yml` and electron-updater checks it against the\n certificate that signed each downloaded update.\n- **AppX / MSIX identity** — the package `Publisher` attribute must equal the certificate\n subject, so electron-builder derives it from this value (or the certificate) to keep them\n in sync; a mismatch makes packaging fail with `ERROR_BAD_FORMAT`.\n\nDefaults to `CN=<common name>` of your code signing certificate, so a renewed certificate with the\nsame common name keeps updates working even when its other subject attributes change. For a stricter\npin, set a fuller DN explicitly (a renewal that changes a configured attribute then needs a release,\nsigned with the old certificate, that lists both DNs).\n**Required** (while `verifyUpdateCodeSignature` is enabled and `app-update.yml` is written) whenever\nno certificate supplies it: with a custom [sign](#sign) hook, even if a certificate is configured,\nfor a certificate without a CN, and when no certificate is configured (e.g. the build is signed\noutside electron-builder) — otherwise the build fails. `null` is no opt-out since v27: a build that\nwrites `app-update.yml` with it fails; set [verifyUpdateCodeSignature](#verifyUpdateCodeSignature)\nto `false` instead."
|
|
9121
9595
|
},
|
|
9122
9596
|
"rfc3161TimeStampServer": {
|
|
9123
9597
|
"default": "http://timestamp.digicert.com",
|
|
@@ -9222,7 +9696,7 @@
|
|
|
9222
9696
|
]
|
|
9223
9697
|
}
|
|
9224
9698
|
],
|
|
9225
|
-
"description": "The publisher name(s) to associate with the signature, written
|
|
9699
|
+
"description": "The publisher name(s) to associate with the signature: a Distinguished Name (DN) of your code\nsigning certificate's subject, written with the attribute names Windows uses (e.g.\n`CN=My Company, O=My Company, C=US`). Every attribute you list must equal the certificate's;\nattributes you leave out are not compared. A bare name (`My Company`) fails the build since v27,\nbecause electron-updater 7 never matches it — see\n[the migration guide](https://www.electron.build/docs/migration/v27-build-changes#windows-publishername-must-be-a-distinguished-name).\nMay be a single string or an array — an array is useful when rotating certificates, so updates\nsigned by either the old or the new certificate still verify.\n\nThis value is not a `signtool` argument; it is consumed in two places:\n- **Update verification** — when [verifyUpdateCodeSignature](#verifyUpdateCodeSignature) is\n enabled, it is written into `app-update.yml` and electron-updater checks it against the\n certificate that signed each downloaded update.\n- **AppX / MSIX identity** — the package `Publisher` attribute must equal the certificate\n subject, so electron-builder derives it from this value (or the certificate) to keep them\n in sync; a mismatch makes packaging fail with `ERROR_BAD_FORMAT`.\n\nDefaults to `CN=<common name>` of your code signing certificate, so a renewed certificate with the\nsame common name keeps updates working even when its other subject attributes change. For a stricter\npin, set a fuller DN explicitly (a renewal that changes a configured attribute then needs a release,\nsigned with the old certificate, that lists both DNs).\n**Required** (while `verifyUpdateCodeSignature` is enabled and `app-update.yml` is written) whenever\nno certificate supplies it: with a custom [sign](#sign) hook, even if a certificate is configured,\nfor a certificate without a CN, and when no certificate is configured (e.g. the build is signed\noutside electron-builder) — otherwise the build fails. `null` is no opt-out since v27: a build that\nwrites `app-update.yml` with it fails; set [verifyUpdateCodeSignature](#verifyUpdateCodeSignature)\nto `false` instead."
|
|
9226
9700
|
},
|
|
9227
9701
|
"rfc3161TimeStampServer": {
|
|
9228
9702
|
"default": "http://timestamp.digicert.com",
|
|
@@ -9340,7 +9814,7 @@
|
|
|
9340
9814
|
]
|
|
9341
9815
|
}
|
|
9342
9816
|
],
|
|
9343
|
-
"description": "The publisher name(s) to associate with the signature, written
|
|
9817
|
+
"description": "The publisher name(s) to associate with the signature: a Distinguished Name (DN) of your code\nsigning certificate's subject, written with the attribute names Windows uses (e.g.\n`CN=My Company, O=My Company, C=US`). Every attribute you list must equal the certificate's;\nattributes you leave out are not compared. A bare name (`My Company`) fails the build since v27,\nbecause electron-updater 7 never matches it — see\n[the migration guide](https://www.electron.build/docs/migration/v27-build-changes#windows-publishername-must-be-a-distinguished-name).\nMay be a single string or an array — an array is useful when rotating certificates, so updates\nsigned by either the old or the new certificate still verify.\n\nThis value is not a `signtool` argument; it is consumed in two places:\n- **Update verification** — when [verifyUpdateCodeSignature](#verifyUpdateCodeSignature) is\n enabled, it is written into `app-update.yml` and electron-updater checks it against the\n certificate that signed each downloaded update.\n- **AppX / MSIX identity** — the package `Publisher` attribute must equal the certificate\n subject, so electron-builder derives it from this value (or the certificate) to keep them\n in sync; a mismatch makes packaging fail with `ERROR_BAD_FORMAT`.\n\nDefaults to `CN=<common name>` of your code signing certificate, so a renewed certificate with the\nsame common name keeps updates working even when its other subject attributes change. For a stricter\npin, set a fuller DN explicitly (a renewal that changes a configured attribute then needs a release,\nsigned with the old certificate, that lists both DNs).\n**Required** (while `verifyUpdateCodeSignature` is enabled and `app-update.yml` is written) whenever\nno certificate supplies it: with a custom [sign](#sign) hook, even if a certificate is configured,\nfor a certificate without a CN, and when no certificate is configured (e.g. the build is signed\noutside electron-builder) — otherwise the build fails. `null` is no opt-out since v27: a build that\nwrites `app-update.yml` with it fails; set [verifyUpdateCodeSignature](#verifyUpdateCodeSignature)\nto `false` instead."
|
|
9344
9818
|
},
|
|
9345
9819
|
"rfc3161TimeStampServer": {
|
|
9346
9820
|
"default": "http://timestamp.digicert.com",
|
|
@@ -9853,7 +10327,7 @@
|
|
|
9853
10327
|
},
|
|
9854
10328
|
"forceCodeSigning": {
|
|
9855
10329
|
"default": false,
|
|
9856
|
-
"description": "Whether to throw an error and abort the build if the app could not be code-signed.\n\nSet to `true` in release pipelines to catch missing or misconfigured signing credentials\nbefore producing unsigned artifacts. When `false` (the default), missing signing credentials\nproduce a warning and the build continues unsigned.",
|
|
10330
|
+
"description": "Whether to throw an error and abort the build if the app could not be code-signed, notarized, or have its\nauto-update manifests signed - and to verify the signatures the build produces.\n\nSet to `true` in release pipelines to catch missing or misconfigured signing credentials\nbefore producing unsigned artifacts. When `false` (the default), missing signing credentials\nproduce a warning and the build continues unsigned.\n\nWith `true`:\n- macOS: the app must be signed, which needs a macOS host, also in pull-request builds (set `CSC_FOR_PULL_REQUEST=true` to sign\n them, or pass `-c.forceCodeSigning=false` there), and notarized: notarization credentials must be set when the build starts.\n The output of a custom `mac.sign` signer is checked with `codesign --verify --deep --strict`, the stapled ticket with\n `stapler validate`, a signed pkg with `pkgutil --check-signature`, and a DMG with `dmg.sign: true` must be signed.\n- Windows: every signed file is read back and must carry a valid Authenticode signature.\n- Every platform (the only effect on Linux): auto-update manifests must be signed, also by a build that does not publish.\n- A prepackaged app, which electron-builder does not sign, must already be signed (and, on macOS, notarized).\n\nExplicit opt-outs are honored with a warning: `mac.notarize: false`, `updateManifest: false`, `win.signExts` exclusions and a\ncustom `nsis.script` (whose uninstaller electron-builder does not sign). `win.sign: false` and `mac.sign: null` contradict it\nand fail the build. `electron-builder verify` checks the build output afterwards.",
|
|
9857
10331
|
"type": "boolean"
|
|
9858
10332
|
},
|
|
9859
10333
|
"freebsd": {
|
|
@@ -10274,7 +10748,7 @@
|
|
|
10274
10748
|
"type": "null"
|
|
10275
10749
|
}
|
|
10276
10750
|
],
|
|
10277
|
-
"description": "Ed25519 signing of the auto-update manifest (`latest*.yml`). Each manifest is signed and its public key is\nembedded into `app-update.yml`, so electron-updater verifies the signature before downloading an update.\n\n**Signing is required.** Publishing a build that emits auto-update metadata fails unless a signing key\nresolves. Generate one once with `electron-builder create-update-key`, then supply it via\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` (the PEM file, base64-encoded) / `ELECTRON_BUILDER_UPDATE_SIGN_KEY_FILE` (its path),\npreferred in CI, or via `signingKey` / `signingKeyFile` below. Leaving this option unset — or `null` — keeps signing required and\nresolves the key from the environment; `null` is not an opt-out.\n\nSet to `false`, the only opt-out, to ship **unsigned** manifests. Every build that produces a manifest then\nlogs a warning. `false` also short-circuits the environment variables, so a leftover\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` in CI cannot re-enable signing by accident.\n\nThe requirement is
|
|
10751
|
+
"description": "Ed25519 signing of the auto-update manifest (`latest*.yml`). Each manifest is signed and its public key is\nembedded into `app-update.yml`, so electron-updater verifies the signature before downloading an update.\n\n**Signing is required.** Publishing a build that emits auto-update metadata fails unless a signing key\nresolves. Generate one once with `electron-builder create-update-key`, then supply it via\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` (the PEM file, base64-encoded) / `ELECTRON_BUILDER_UPDATE_SIGN_KEY_FILE` (its path),\npreferred in CI, or via `signingKey` / `signingKeyFile` below. Leaving this option unset — or `null` — keeps signing required and\nresolves the key from the environment; `null` is not an opt-out.\n\nSet to `false`, the only opt-out, to ship **unsigned** manifests. Every build that produces a manifest then\nlogs a warning. `false` also short-circuits the environment variables, so a leftover\n`ELECTRON_BUILDER_UPDATE_SIGN_KEY` in CI cannot re-enable signing by accident.\n\nThe requirement is enforced when a publish policy is in effect (`--publish`) or `forceCodeSigning` is set; any other\nbuild warns instead, so local builds and pipelines that sign the manifest in a later step of their own are\nunaffected. It is also waived when every publish provider has `publishAutoUpdate: false`, since no manifest is\nemitted then, and for a build whose targets write no update info (e.g. only snap, flatpak, MSI/MSIX, portable,\nmas/pkg or plain archives). A publishing (or `forceCodeSigning`) build checks for the key at build start, before\nanything is packed or uploaded. Every signed manifest is read back and verified before it is written.\n\nSee [Signed Update Manifests](https://www.electron.build/features/signed-update-manifests)."
|
|
10278
10752
|
},
|
|
10279
10753
|
"win": {
|
|
10280
10754
|
"anyOf": [
|