Skip to content

Releases

electron-updater@7.0.0-alpha.14

Pre-release

Choose a tag to compare

@electron-builder-release-bot electron-builder-release-bot released this 21 Nov 01:21
Immutable release. Only release title and notes can be modified.
1b1696b

Major Changes

  • Fix(updater)!: reject an update manifest whose YAML aliases expand to more than 100000 values, keys and string characters (or more than the length of a larger file) with ERR_UPDATER_INVALID_UPDATE_INFO, so comparing or serializing the update info cannot freeze the app. electron-updater 6 accepted such a manifest; manifests electron-builder writes contain no aliases and are unaffected, but one that another tool writes or rewrites with aliases (e.g. js-yaml dump without noRefs) stops updating installs: write it without aliases or with the shared values repeated inline. The error links the migration guide. Private GitHub repositories parse their manifest the same way as the other providers, and the Bitbucket and Keygen providers report a manifest they cannot parse with ERR_UPDATER_INVALID_UPDATE_INFO (was ERR_UPDATER_LATEST_VERSION_NOT_FOUND). The ERR_UPDATER_INVALID_UPDATE_INFO messages name the channel file URL without its query string, so a token in the feed URL is not logged. #10514 a61262c

    See https://www.electron.build/docs/migration/v27-runtime-changes#update-manifest-yaml-aliases-are-limited

  • Fix(updater)!: a deb/rpm/pacman update installed with gksudo, kdesudo or beesu needs an installer path of ASCII letters, digits and ._/+,:=@%- (and a space with kdesudo), and non-ASCII characters other than control, format and separator characters, the characters their single command string carries safely; any other path fails with ERR_UPDATER_UNSAFE_INSTALLER_PATH before the helper runs. pkexec and sudo take any path. #10524 d996835

  • Feat(updater)!: the app chooses the request headers sent to another origin with the required autoUpdater.crossOriginHeaders property: (headerNames: string[], hop: { from: URL; to: URL }) => string[] (the CrossOriginHeadersCallback and CrossOriginHop types), null by default. electron-updater calls it for each request and redirect to another origin than the update feed (Provider.feedBaseUrl; private GitHub's feed is the GitHub API): a redirect, a download or channel file on another origin, a blockmap or differential range request and their redirects, a private GitHub release asset or GitLab release link on another origin, and a provider's own request there. It gets the lowercase names of the request headers about to be sent, never their values, and returns the names of the ones to send (case-insensitive); the feed's origin gets every header without it. A header it leaves out stays on the original origin: Authorization from addAuthHeader, a custom header from requestHeaders, a provider's token (private GitHub, GitLab), a provider's other request headers and x-user-staging-id. The headers electron-updater builds for each request itself are sent whatever it returns: its default User-Agent, Cache-Control, the Accept it or the provider sets, and Range; an app's own User-Agent from requestHeaders goes to another origin only when it keeps user-agent. autoUpdater.crossOriginHeaders = () => [] sends none of the app's headers to another origin. Without a function, checkForUpdates(), checkForUpdatesAndNotify() and downloadUpdate() emit error and reject with ERR_UPDATER_CROSS_ORIGIN_HEADERS_NOT_CONFIGURED, whose message names the property and links the migration guide, and so does each request to another origin, such as one of the install at launch of an update marked for the next launch: set it before the app is ready. An unpackaged app without forceDevUpdateConfig, which skips the check, gets the same error from checkForUpdates() and checkForUpdatesAndNotify(), so a missing callback shows up in development. A throw, or a result that is not an array of strings, fails that request, unsent, with ERR_UPDATER_INVALID_CROSS_ORIGIN_HEADERS. builder-util-runtime: HttpExecutor takes a CrossOriginHeaderPolicy ((headers, hop) => headers) for its redirects as its constructor argument, by default electron-builder's, which leaves out the credential-bearing headers (see addSensitiveRedirectHeader); HttpExecutor.crossOriginHeaders(headers, ownHeaders, hop, policy) applies one, and ApiRequestOptions.ownHeaders and DownloadOptions.ownHeaders name the headers a request builds itself, which a hop to another origin sends whatever the policy keeps. electron-updater's ProviderRuntimeOptions has a required crossOriginHeaderPolicy, set by electron-updater, so code that constructs a built-in provider passes on the runtime options it was given. The first time a request to an origin goes without some of the app's or a provider's headers, electron-updater logs a warning, once per origin, naming those headers and both origins (never a value), with a link to the migration guide. A Host header is never sent to another origin. A provider constructed with runtime options without a crossOriginHeaderPolicy function throws ERR_UPDATER_CROSS_ORIGIN_HEADER_POLICY_MISSING. See https://www.electron.build/docs/migration/v27-runtime-changes#cross-origin-headers #10563 d699bdf — electron-updater, builder-util-runtime

  • Feat!: electron-updater sends every update-feed request header and the feed query only to downloads on the feed's origin. With the generic, s3, spaces, r2, keygen, bitbucket, github and gitlab providers, a download on another origin than the feed (scheme, host or port) — an absolute files[].url or packages.<arch>.path in latest*.yml, a GitLab release asset link, and the blockmaps and differential range requests derived from them — is requested with only the headers from requestHeaders / addAuthHeader that the app's autoUpdater.crossOriginHeaders keeps (see https://www.electron.build/docs/migration/v27-runtime-changes#cross-origin-headers) and without the feed URL's query string. Such a URL keeps its own query string, so pre-signed URLs work. With every provider, including custom ones, a URL that electron-updater resolves against the feed URL (such as a files[].url or a blockmap) gets the feed query only on the feed's origin; as on redirects, an http → https upgrade of the feed host on the default ports keeps the headers and the query. Downloads on the feed origin get every request header and the feed query, and the old blockmap from an app-set previousBlockmapBaseUrlOverride gets every request header on that origin. If your latest*.yml points downloads at another origin that needs these headers, serve the files from the feed origin, use pre-signed URLs, or keep the headers for that origin in autoUpdater.crossOriginHeaders. The NSIS web-package differential download uses the same per-download headers as other downloads. Every provider returns its feed URL from Provider.feedBaseUrl: the built-in ones return theirs (private GitHub returns the GitHub API, whose asset URLs need its token), and a custom provider whose feedBaseUrl is not a URL, null included, fails the update check with ERR_UPDATER_FEED_BASE_URL_NOT_DECLARED before it gets any request header (see https://www.electron.build/docs/migration/v27-developer-changes#custom-provider-feed-base-url). The first download that does not get the feed query logs a warning once per updater, naming the query parameters and the origins (never their values), with a link to the migration guide. New APIs: Provider.feedBaseUrl (required), HttpExecutor.crossOriginHeaders and HttpExecutor.isCrossOrigin. #10270 ec9135d — electron-updater, builder-util-runtime · updated in #10563

  • Feat(updater)!: reject plain http update requests and https-to-http redirects (except to a loopback host) with ERR_UPDATER_INSECURE_FEED unless the app sets AppUpdater.allowInsecureFeed, which is meant for development (autoUpdater.allowInsecureFeed = !app.isPackaged): a packaged app with it set logs a warning once, the first time it loads update info (an update check, or the validation of an update pending install at launch); the build warns when the feed written to app-update.yml (a generic or custom publish url, a github protocol: "http" or an s3 endpoint without accelerate) uses plain http to a host that is not loopback. With allowInsecureFeed, a server's authentication challenge on a request that is neither https nor to a loopback host is cancelled without emitting login. A redirect to a loopback host (http or https) from a URL that is not on one fails with ERR_UPDATER_LOOPBACK_REDIRECT, whatever allowInsecureFeed is; ApiRequestOptions.redirectedFromNonLoopback carries that through a redirect chain. https://www.electron.build/docs/migration/v27-runtime-changes#update-requests-require-https #10566 e955338 — electron-updater, builder-util-runtime

  • Feat(nsis)!: an nsis-web installer started as an update (--updated) without --package-file aborts (exit code 2), electron-updater rejects a web-installer update without a package for the app's arch or ia32 before downloading it (ERR_UPDATER_NO_WEB_PACKAGE_FOR_ARCH), and the NSIS updater installs an update whose mani...

Read more

electron-builder@27.0.0-alpha.15

Pre-release

Choose a tag to compare

@electron-builder-release-bot electron-builder-release-bot released this 21 Nov 01:21
Immutable release. Only release title and notes can be modified.
1b1696b

Major Changes

  • Feat(nsis)!: an nsis-web installer started as an update (--updated) without --package-file aborts (exit code 2), electron-updater rejects a web-installer update without a package for the app's arch or ia32 before downloading it (ERR_UPDATER_NO_WEB_PACKAGE_FOR_ARCH), and the NSIS updater installs an update whose manifest signature is not verified only when the ProductVersion of its installer is the update version (ERR_UPDATER_INSTALLER_VERSION_MISMATCH) #10601 03cf406 — app-builder-lib

Minor Changes

  • Feat(toolsets): add the archive toolset (xz, lzip, GNU tar/ar and bsdtar on Linux x64/arm64/ia32 and macOS arm64/x64, plus rpmbuild from rpm 6.1.0 on Linux x64/arm64 and macOS arm64), put first on fpm's PATH on macOS and Linux and used for tar.lz. It replaces toolsets.linuxToolsMac; Intel macOS and 32-bit Linux build rpm with the host rpmbuild. A leftover toolsets.linuxToolsMac key fails config validation; remove it or use toolsets.archive #10475 a090dad — app-builder-lib
  • Feat(updater): channel files (latest*.yml) are limited to 10 MiB, since they are parsed before anything verifies them: a larger one fails the update check with ERR_UPDATER_RESPONSE_TOO_LARGE. maxUpdateInfoSize in the publish configuration (written into app-update.yml) or autoUpdater.maxUpdateInfoSize sets the limit in bytes, or 0 for none. #10508 c79e07c — app-builder-lib, builder-util-runtime
  • Feat(updater)!: reject plain http update requests and https-to-http redirects (except to a loopback host) with ERR_UPDATER_INSECURE_FEED unless the app sets AppUpdater.allowInsecureFeed, which is meant for development (autoUpdater.allowInsecureFeed = !app.isPackaged): a packaged app with it set logs a warning once, the first time it loads update info (an update check, or the validation of an update pending install at launch); the build warns when the feed written to app-update.yml (a generic or custom publish url, a github protocol: "http" or an s3 endpoint without accelerate) uses plain http to a host that is not loopback. With allowInsecureFeed, a server's authentication challenge on a request that is neither https nor to a loopback host is cancelled without emitting login. A redirect to a loopback host (http or https) from a URL that is not on one fails with ERR_UPDATER_LOOPBACK_REDIRECT, whatever allowInsecureFeed is; ApiRequestOptions.redirectedFromNonLoopback carries that through a redirect chain. https://www.electron.build/docs/migration/v27-runtime-changes#update-requests-require-https #10566 e955338 — app-builder-lib, builder-util-runtime
  • Feat(runtime): HttpExecutor.addRedirectHandlers is public, so that requests made outside the executor (electron-updater's differential downloads) follow redirects with the same rules: a redirect to another origin sends the headers the executor's cross-origin header policy keeps, plus the request's own (ownHeaders), and the executor's redirect limit applies #10419 2d97c85 — builder-util-runtime · updated in #10568
  • Feat: add electron-builder sign-update-manifest <files..> to re-sign an edited latest*.yml in place without rebuilding. Like publish it reads the project configuration (-c / --config, including -c.updateManifest.signingKeyFile=... overrides) and signs with the key(s) the build would use — updateManifest.signingKey / signingKeyFile per platform, then ELECTRON_BUILDER_UPDATE_SIGN_KEY(_FILE) — refusing, like a publishing build, signing keys outside an explicit updateManifest.publicKey unless allowSigningKeyOutsideTrustList is set, after validating the manifest shape and dropping the old signature/signatures, keeping every other field; --verify checks the existing signatures without writing, with the same check and outcomes as electron-builder verify (against updateManifest.publicKey, honoring updateManifest: false and allowSigningKeyOutsideTrustList, and never loading a signing key). Re-signing refuses a manifest whose sha512 or size does not match a listed file (found next to the manifest or in the build output folder, by name or GitHub-safe name, as electron-builder verify finds it), since electron-updater rejects such a download; --rehash takes both from the files instead, for artifacts a release step changed after the build (for example Linux packages signed separately), and the docs' manual re-sign script does the same where electron-builder cannot run. A manifest that is a symlink is refused rather than followed. electron-builder verify now also finds a file a GitHub manifest lists by its safe name under its local name (spaces instead of -), so a file changed after the build is reported as changed rather than missing, and a listed file found by its name is no longer reported as matching because an unchanged copy of the original sits elsewhere in the output. sign-update-manifest likewise refuses a listed file it cannot find while the searched folders hold other files of the release, and signs without the check (with a warning) only when none are there. A missing key fails with an InvalidConfigurationError, and key material is never printed. An unreadable signing key file now fails with an InvalidConfigurationError naming its source instead of a raw ENOENT. #10423 94d4d46 — electron-builder, app-builder-lib, builder-util
  • Feat(builder-util): walk takes an optional fourth argument, a WalkSource with readdir(dir) and lstat(file), to walk a tree other than the file system (such as the files of an asar archive) with the same filter and consumer. Without it, walk reads the file system as before. #10585 ab86bb6 — builder-util
  • Feat(nsis): add nsis.allowUnelevatedPerMachineUpdate (off by default). For an assisted installer without perMachine, a silent update of a per-machine installation skips the UAC prompt only when the installed version was built with the option too and the user already holds every right the update uses: on the installation folder, its files and its parent, the HKLM install and Uninstall keys and their parent keys, and the all-users shortcuts. The installer and uninstaller check these rights without writing anything, and elevate as before when one is missing, when a per-user installation exists too, or for an interactive install or uninstall. Setting the option for a one-click or perMachine installer is a configuration error. #10495 f18cf20 — app-builder-lib

Patch Changes

  • Fix: update the default sevenZip toolset to 1.1.0. It bundles 7-Zip 26.05 (was 24.09), which picks up upstream security fixes including CVE-2025-11001 / CVE-2025-11002 (ZIP symlink path traversal), CVE-2025-55188 (symlink handling) and CVE-2026-14266 (XZ decoder heap overflow). Explicit toolsets.sevenZip pins (1.0.0, 1.0.1) are unchanged #10478 3c7393b — app-builder-lib
  • Fix(linux): update the default appimage toolset to 1.2.1, the license-corrected re-release of 1.2.0 (which was flagged for missing license files and is removed as a pin). Its mksquashfs (squashfs-tools 4.7.5) links a pinned static zstd 1.5.7, so Linux and macOS hosts now build byte-identical AppImages. Explicit toolsets.appimage pins (0.0.0, 1.0.3, 1.1.0) are unchanged. A toolsets.appimage: "1.2.0" pin (the v27.0.0-alpha.14 default) now fails as an unknown version; move it to "1.2.1" or "latest" #10490 69d7e6b — app-builder-lib
  • Fix(linux): update the default fpm toolset to 2.3.1 (fpm 1.18.0, Ruby 3.4.12). Its Linux bundles link a static OpenSSL 3.5.9 instead of Debian buster's end-of-life OpenSSL 1.1.1, with the same glibc 2.28 floor. The archive name is now looked up per version, so an explicit toolsets.fpm: "2.2.1" pin still downloads the fpm 1.17.0 bundle, and an unknown version throws a configuration error #10481 36d06a7 — app-builder-lib
  • Fix(squirrel-windows): update the defau...
Read more

electron-updater@7.0.0-alpha.13

Pre-release

Choose a tag to compare

@electron-builder-release-bot electron-builder-release-bot released this 29 Oct 01:14
Immutable release. Only release title and notes can be modified.
3c02dca

Minor Changes

  • Feat(updater): on Linux (deb, rpm, pacman), a failed install on quit (e.g. the authentication dialog dismissed) emits and logs error and the app exits without the update, unless the new cancelQuitOnInstallFailure option is set: the install on quit then runs from will-quit and cancels the quit when it fails (the app keeps running with its windows closed, so reopen a window or quit from a later tick on error; register the app's own will-quit listeners before checking for updates, the updater only sees cancellations from listeners registered before its own). A quit while an update install runs waits for it to finish, a failed install is not retried by a later quit of the session (also for update info with only a legacy sha2 checksum), and a dismissed or denied pkexec dialog stops the install instead of showing a second dialog for the apt-get -f or pacman -Sy recovery #10460 e15f702

  • Feat: binary, range-fetchable .blockmap format, chosen from electronUpdaterCompatibility (default raised to >=7). The block map published next to NSIS installers and macOS update zips is read by the electron-updater already installed in the users' apps, so its format follows the declared range: a range of electron-updater 7 and later (the new default) writes the binary map, a range that includes earlier versions writes the gzipped JSON map, with a once-per-build warning. The new blockmap option, "v2" | "v3" | "latest", overrides the choice: "v2" is the JSON map (format version 2), "v3" the binary map (failing the build when the range includes electron-updater before 7), "latest" the newest format the range allows. The build also fails when the app's own electron-updater dependency is outside electronUpdaterCompatibility, e.g. electron-updater 6 with the default >=7: upgrade it, or set electronUpdaterCompatibility: ">=6" to keep the JSON map. #10312 c983462 — electron-updater, builder-util-runtime

    The binary map is uncompressed with fixed-size tables (header, content-defined super-groups of groups, content-defined groups of blocks, 10-byte per-block records, with 8-byte hashes at every level). electron-updater fetches the header and super-group table with one Range request, matches super-groups against its cached previous map, fetches only the group entries of the super-groups that changed, matches those groups and fetches only the records of the groups that changed, verifies every hash, then runs the existing block-level plan and download pipeline. If that range fetch fails, it downloads the new map with a plain GET and stays differential. Because the map cost grows with the change rather than with the installer, the stored app.asar region (nsis.differentialPackage: "store-asar", ideally with asar.contentAlignment) uses 512 B / 1 KiB / 2 KiB blocks and a block boundary at every packed file, and the 7z header of a differential-aware package is stored as is (-mhc=off) and chunked into its own small blocks, so a changed CRC no longer re-downloads the trailing block of the package (5–30 KB on every update). Builds that write the JSON map keep packages and block maps byte-for-byte as before. electron-updater tells the formats apart by the file's first bytes, so there is no extra artifact and latest.yml is unchanged. Installs still on electron-updater 6 download the first release with a binary map in full once; the update brings an updater that reads it. A format change between two releases costs the same one-time full download, logged once at info. Block maps embedded in an artifact (AppImage, NSIS web installer packages) stay JSON. A binary .blockmap is uploaded to S3 as application/octet-stream.

    electron-updater additionally downloads through COPY gaps smaller than 8 KiB between two changed ranges on single-range hosts such as GitHub and S3 (one request per range there makes re-downloading a few KiB cheaper than an extra request), only up to 256 B on hosts that serve multipart/byteranges, and caps multipart/byteranges requests at 200 ranges (Apache's MaxRanges default; larger Range headers exceed common 8 KB header limits).

Patch Changes

  • Fix(updater): install deb/rpm/pacman updates without freezing the app while the elevation dialog is open. quitAndInstall() and installPendingUpdateIfAvailable() now run the package manager asynchronously and quit once it finished; the commands, environment and elevation helper are unchanged, the on-quit install stays synchronous, and other platforms are unaffected. The package manager's output goes to a file instead of a pipe, so quitting the app mid-install no longer kills it with SIGPIPE, and a failed install's error now ends with what it wrote to stderr #10094 3c4d9b5
  • Fix(updater): the install on quit follows autoInstallEvent as it is when the app quits, also when it was "manual" while the update downloaded, and the updater logs why nothing is installed when the app quits before the update finished downloading and verifying, without installing an update cached by an earlier launch that verifyUpdateFile has not accepted yet #10095 ea65a06
  • Fix(updater): deb/rpm/pacman installs pass the package-manager command to pkexec and sudo as an argv array, without a shell, both for quitAndInstall() / installPendingUpdateIfAvailable() and for the install when the app quits (autoInstallEvent: "onQuit"): the authentication dialog shows the command being authorized, the installer path is passed unescaped (paths containing a single quote are supported), the command is looked up in /usr/sbin, /usr/bin, /sbin and /bin rather than the caller's PATH, and Node's DEP0190 warning does not apply. gksudo, kdesudo and beesu take a single command string and keep the /bin/bash -c form. A command killed by a signal during the install on quit is reported as a failure #10095 ea65a06
  • Fix(updater): elevate Linux package installs with pkexec (polkit) whenever it is installed; gksudo and kdesudo, which are unmaintained, removed from Debian and Ubuntu and do not work under Wayland, are only used on systems without polkit, and the updater logs once when it skips one #10095 ea65a06
  • Fix: cache the downloaded update's blockmap before emitting update-downloaded, so an app that calls quitAndInstall() from that listener still makes its next update differential #10463 a712cc9
  • Fix: download the full update, without a failed differential attempt, when the installed version's blockmap URL is the update's own (artifact name without version) or the downloaded old blockmap does not describe the cached installer #10463 a712cc9
  • Fix(updater): a failed install() or installAsync() no longer blocks every later install in the session: the next quit installs the update (on Linux deb/rpm/pacman, only a different update, so the dismissed authentication dialog is not shown again on quit), and the protected quitAndInstallCalled is deprecated #10467 476c3d5
  • Fix(updater): the Linux install only elevates a bare command name found as an executable regular file in the system directories (/usr/sbin, /usr/bin, /sbin, /bin), symlinks included only when their target lies there too #10460 e15f702
  • Fix(updater): route all updater logging through a non-throwing logger (with an always-present debug), so a throwing logger or one without debug() cannot interrupt the update logic (exposed to subclasses as a protected log getter); autoUpdater.logger still returns the logger the app set #10470 cbd5c80
  • Fix: don't log "Differential download failed" on macOS when no differential download was attempted #10486 26195ba

electron-builder@27.0.0-alpha.14

Pre-release

Choose a tag to compare

@electron-builder-release-bot electron-builder-release-bot released this 29 Oct 01:14
Immutable release. Only release title and notes can be modified.
3c02dca

Major Changes

  • Feat(msi): build msi and msiWrapped installers with WiX 3.14.1 (toolsets.wix), native arm64 MSIs (#10354) #10404 dacb1ec — app-builder-lib

    BREAKING CHANGE: toolsets.wix unset or "latest" (= "2.0.0") builds msi and msiWrapped installers with WiX 3.14.1, which produces a native Arm64 MSI for arm64 builds. toolsets.wix: "0.0.0" keeps the previous WiX 4.0.0.5512 preview bundle, which packages an arm64 app in an x64 MSI. The WiX 3 project uses the WiX 3 namespace, nested Directory elements (also for a nested menuCategory) and explicit ids for files in subdirectories; it keeps the upgrade code, install paths and file layout. An msiProjectCreated hook that inserts elements of a WiX 4 extension namespace must use the WiX 3 one (for example http://schemas.microsoft.com/wix/UtilExtension) or pin "0.0.0"; with WiX 3, a project that still declares a WiX 4 namespace after the hook fails the build with an InvalidConfigurationError that names it. A custom bundle ({ url, checksum }) must have the WiX 3 layout.

Minor Changes

  • Feat: binary, range-fetchable .blockmap format, chosen from electronUpdaterCompatibility (default raised to >=7). The block map published next to NSIS installers and macOS update zips is read by the electron-updater already installed in the users' apps, so its format follows the declared range: a range of electron-updater 7 and later (the new default) writes the binary map, a range that includes earlier versions writes the gzipped JSON map, with a once-per-build warning. The new blockmap option, "v2" | "v3" | "latest", overrides the choice: "v2" is the JSON map (format version 2), "v3" the binary map (failing the build when the range includes electron-updater before 7), "latest" the newest format the range allows. The build also fails when the app's own electron-updater dependency is outside electronUpdaterCompatibility, e.g. electron-updater 6 with the default >=7: upgrade it, or set electronUpdaterCompatibility: ">=6" to keep the JSON map. #10312 c983462 — app-builder-lib, builder-util-runtime, electron-publish

    The binary map is uncompressed with fixed-size tables (header, content-defined super-groups of groups, content-defined groups of blocks, 10-byte per-block records, with 8-byte hashes at every level). electron-updater fetches the header and super-group table with one Range request, matches super-groups against its cached previous map, fetches only the group entries of the super-groups that changed, matches those groups and fetches only the records of the groups that changed, verifies every hash, then runs the existing block-level plan and download pipeline. If that range fetch fails, it downloads the new map with a plain GET and stays differential. Because the map cost grows with the change rather than with the installer, the stored app.asar region (nsis.differentialPackage: "store-asar", ideally with asar.contentAlignment) uses 512 B / 1 KiB / 2 KiB blocks and a block boundary at every packed file, and the 7z header of a differential-aware package is stored as is (-mhc=off) and chunked into its own small blocks, so a changed CRC no longer re-downloads the trailing block of the package (5–30 KB on every update). Builds that write the JSON map keep packages and block maps byte-for-byte as before. electron-updater tells the formats apart by the file's first bytes, so there is no extra artifact and latest.yml is unchanged. Installs still on electron-updater 6 download the first release with a binary map in full once; the update brings an updater that reads it. A format change between two releases costs the same one-time full download, logged once at info. Block maps embedded in an artifact (AppImage, NSIS web installer packages) stay JSON. A binary .blockmap is uploaded to S3 as application/octet-stream.

    electron-updater additionally downloads through COPY gaps smaller than 8 KiB between two changed ranges on single-range hosts such as GitHub and S3 (one request per range there makes re-downloading a few KiB cheaper than an extra request), only up to 256 B on hosts that serve multipart/byteranges, and caps multipart/byteranges requests at 200 ranges (Apache's MaxRanges default; larger Range headers exceed common 8 KB header limits).

Patch Changes

  • Fix(nsis): skip the assisted installer's license page on the first visit in the elevated inner instance only if it was accepted in the outer instance. Keep the license visible when elevation occurs before any pages are shown, and preserve Back navigation. #10377 b66a4e1 — app-builder-lib
  • Fix: point the docs links in Bitbucket, Keygen, R2, Spaces and Squirrel.Windows configuration errors at existing sections #10462 4152802 — electron-builder-squirrel-windows, electron-publish
  • Fix(rpm): build RPMs without /usr/lib/.build-id links and with v4 package format so output is the same on every build host (#10471) #10472 60ce3ed — app-builder-lib
  • Fix(linux): update the default appimage toolset to 1.2.0. Its mksquashfs (squashfs-tools 4.7.5) links a pinned static zstd 1.5.7, so Linux and macOS hosts now build byte-identical AppImages. Explicit toolsets.appimage pins (0.0.0, 1.0.3, 1.1.0) are unchanged #10473 e246f99 — app-builder-lib
  • Fix(blockmap): check the app's electron-updater against the electronUpdaterCompatibility of every platform the build targets, instead of passing when any declared range includes it (e.g. win.electronUpdaterCompatibility: ">=6" no longer lets a macOS build with the default >=7 write binary block maps for an app on electron-updater 6). Where the build writes binary block maps (an NSIS installer, a macOS zip target), electron-updater 7.0.0-alpha.0 to 7.0.0-alpha.12, which cannot read them, fail the build; an electron-updater bundled from devDependencies, or from the development package.json of a two package.json project, is checked like one in dependencies. The publish and verify commands, which write no update files, no longer check it against electronUpdaterCompatibility. An NSIS installer with a JSON ("v2") block map no longer reads the asar and 7z archive headers that only the binary ("v3") map uses. #10485 24c9ead — app-builder-lib

Full Changelog: https://github.com/electron-userland/electron-builder/compare/electron-builder@27.0.0-alpha.13...electron-builder@27.0.0-alpha.14

electron-updater@6.8.12

Choose a tag to compare

@electron-builder-release-bot electron-builder-release-bot released this 26 Oct 12:33
Immutable release. Only release title and notes can be modified.
f979f0e

Patch Changes

  • Fix(updater): every request of a differential download (single-range, multi-range and reading the embedded block map) follows redirects itself: credential headers such as Authorization, PRIVATE-TOKEN, X-Api-Key and Cookie are sent to a redirect target only on the same origin, each multi-range request starts at the update URL, at most 10 redirects are followed per request, and an invalid redirect URL fails the download instead of leaving it waiting #10447 99e0dc5 @claude
  • Fix(updater): differential downloads made with single range requests no longer send credential headers such as Authorization to a redirect target on another origin, which made pre-signed S3 or R2 URLs reject the range requests and forced a full download #10427 a1a74b1 @claude
  • Fix: stop following redirects after 10 hops on the Electron path, matching the Node path #10452 d80fc04 @claude
  • Fix(nsis): don't plan a differential download against a cached block map of another release. The cached block map is replaced when a download finishes, but the cached installer only when the update is installed, so a release found before the previous one was installed was planned against the wrong base: every differential byte was downloaded, the sha512 check failed, and the full installer was downloaded too. A cached block map that does not end at the cached installer's size is now ignored and the installed version's block map is fetched from the server. #10338 6f2dd83 @imlucas
  • Fix: reject update download redirects to non-HTTP(S) URLs instead of throwing an uncaught exception #10450 1c5002e @claude
Updated 1 dependency

ed8990b 99e0dc5 02d65d5

  • builder-util-runtime@9.7.1

electron-builder@26.18.1

Choose a tag to compare

@electron-builder-release-bot electron-builder-release-bot released this 26 Oct 12:33
Immutable release. Only release title and notes can be modified.
f979f0e

Patch Changes

Updated 4 dependencies

ed8990b 80ec271 f7526d8 bb061e8 99e0dc5 02d65d5 3fd038f

  • builder-util-runtime@9.7.1
  • app-builder-lib@26.18.1
  • builder-util@26.18.1
  • dmg-builder@26.18.1

electron-updater@7.0.0-alpha.12

Pre-release

Choose a tag to compare

@electron-builder-release-bot electron-builder-release-bot released this 26 Oct 12:38
Immutable release. Only release title and notes can be modified.
04262af

Major Changes

  • Feat(win)!: a missing publisherName fails Windows update signature verification closed. #10380 674e18d — electron-updater, builder-util-runtime

    • electron-updater: an NSIS update is rejected with ERR_UPDATER_INVALID_SIGNATURE when app-update.yml (or dev-app-update.yml / the updateConfigPath file) has no publisherName. A custom verifyUpdateFileAuthenticodeSignature / verifyUpdateCodeSignature is never called without a publisherName. The only opt-out is verifyUpdateCodeSignature: false in app-update.yml, which electron-builder writes for win.verifyUpdateCodeSignature: false; verification is then skipped with one warning per updater. An app with no update config file at all (no app-update.yml / dev-app-update.yml, e.g. one that only uses setFeedURL) is not verified: its feed is configured by the developer.
    • app-builder-lib: a Windows build that writes app-update.yml (nsis, nsis-web or electronUpdaterAware appx with a publish configuration of any provider, including one inferred from a GitHub repository) fails with InvalidConfigurationError while win.verifyUpdateCodeSignature is enabled and no publisherName resolves: win.sign: false / null, no code signing certificate, or win.sign.publisherName: null, which is not an opt-out. Sign the build, set win.sign.publisherName (e.g. win.sign: { type: "signtool", publisherName: [...] } when signing outside electron-builder), or set win.verifyUpdateCodeSignature: false, which writes verifyUpdateCodeSignature: false (and no publisherName) into app-update.yml. A publisherName in the publish configuration must be a distinguished name too, and verifyUpdateCodeSignature must not be set there.
    • builder-util-runtime: PublishConfiguration has the private, Windows-only verifyUpdateCodeSignature field.
    • electron-builder: migrate-schema prints an advisory for win.sign: false / null or win.sign.publisherName: null without win.verifyUpdateCodeSignature: false.

    See https://www.electron.build/docs/migration/v27-build-changes#missing-publishername-fails-update-verification

  • Feat(win)!: matchPublisherName matches only publisher names that are a distinguished name (DN), every attribute of which must equal the signer's; a bare name never matches the signer's Common Name any more, and its logger parameter is removed. New export isValidPublisherNameDn tells whether a publisher name is a DN. See https://www.electron.build/docs/migration/v27-build-changes#windows-publishername-must-be-a-distinguished-name #10380 674e18d — builder-util-runtime

  • Feat(updater)!: Windows update signature verification fails closed — electron-updater installs an NSIS update only when PowerShell (Get-AuthenticodeSignature) verifies it: an update it cannot verify (PowerShell cannot be started or run, times out, or prints unreadable output) is rejected with ERR_UPDATER_SIGNATURE_UNVERIFIABLE, and a Windows catalog signature is rejected as invalid unless the app opts in with the new NsisUpdater.allowCatalogSignature (default false; when true, a valid catalog signature is accepted with a warning only when its signer matches publisherName). A release can allow it instead with the new win.allowCatalogSignature build option (default false), which writes allowCatalogSignature: true into the latest.yml of the nsis and nsis-web targets; electron-updater honors it only when that manifest's signature was verified against a trusted key (updateManifestPublicKey) and ignores it with a warning otherwise. The manifest signature covers it as an extra allowCatalogSignature:true line of the EBUM1 payload only when it is true, so manifests without it canonicalize and verify exactly as before, and changing it for a published release means re-signing or republishing latest.yml; a signed manifest with a non-boolean allowCatalogSignature is rejected. electron-updater 7.0.0-alpha.8 to alpha.11 installs with an update key configured reject a signed manifest that sets it (ERR_UPDATER_MANIFEST_SIGNATURE_INVALID), the same way alpha.8 treats a signed files[].blockMapUrl. UpdateInfoAndProvider gains manifestSignatureVerified, and BaseUpdater.verifyInstallerSignatureOnLaunch receives the update info the cached installer was matched against. PowerShell is started by absolute path, the installer path is passed in an environment variable, and non-ASCII output is escaped instead of setting a console encoding, so verification works under PowerShell Constrained Language Mode (fixing 7.0.0-alpha.8 to alpha.10). The build-time installer check uses the same invocation. builder-util-runtime adds prepareAuthenticodeSignatureExec and POWERSHELL_ASCII_ESCAPE_FUNCTION. Migration: where PowerShell may be blocked (AppLocker / WDAC), assign a native verifyUpdateFileAuthenticodeSignature in your first electron-updater 7 release — see https://www.electron.build/docs/migration/v27-runtime-changes#windows-update-signature-verification-fails-closed #10416 8366dc6 — electron-updater, builder-util-runtime

  • Feat(win)!: the default Authenticode verification of NSIS updates accepts an update only when a publisherName entry in distinguished name (DN) format (e.g. "CN=My Company, O=My Company, C=US") matches its signer: a bare name, which used to match the signer's Common Name with a warning, never matches. Such an entry (from an app-update.yml written by electron-builder before v27, a dev-app-update.yml or a direct call of verifyUpdateFileAuthenticodeSignature) is warned about once per updater, and the ERR_UPDATER_INVALID_SIGNATURE failure names it. Build the app with electron-builder v27, which writes a DN (CN=<common name> of the certificate unless publisherName is configured). See https://www.electron.build/docs/migration/v27-build-changes#windows-publishername-must-be-a-distinguished-name #10380 674e18d

  • Refactor(win)!: remove the escapePowerShellSingleQuotes export, which only shipped in 10.0.0-alpha.11; the Authenticode check passes the file path to PowerShell in an environment variable (prepareAuthenticodeSignatureExec), so no path is quoted into a PowerShell script. #10453 ed05bd0 — builder-util-runtime

Minor Changes

  • Feat: warn on silently skipped update signature verification and validate publisherName against the signing certificate at build time #10056 331afdd — updated in #10380

    Two guards around Windows update signature verification:

    • electron-updater: when app-update.yml exists but contains no publisherName, the updater used to skip signature verification (including custom verifyUpdateCodeSignature hooks) completely silently. It now logs a warning explaining that verification was skipped, how to fix it (sign the build so publisherName is derived automatically, or set win.publisherName explicitly), and that this fail-open behavior is deprecated. Since v27 (electron-updater 7), a missing publisherName in an existing app-update.yml is a verification failure (fail-closed) instead, unless the file has verifyUpdateCodeSignature: false. The no-app-update.yml path (unpackaged/dev mode) stays silent.
    • app-builder-lib: when publisherName is explicitly configured and the subject of the local code signing certificate is known, the build now fails with a clear error if none of the configured names match the certificate (same DN-subset/CN matching semantics as the updater's verifier; any one of multiple configured names matching passes, so certificate-rotation setups keep working). This catches signing with the wrong certificate at build time instead of at update time. The check is skipped whenever the actual signing certificate's subject is not genuinely known (custom sign hooks, Azure Trusted Signing, PKCS#11 without an extractable certificate, x509 files without a CN), and publisherName: null remains a pure opt-out.
  • Feat(runtime): HttpExecutor.addRedirectHandlers is public, so that requests made outside the executor (electron-updater's differential downloads) follow redirects with the same rules: credential headers are dropped on another origin, and the executor's redirect limit applies #10419 2d97c85 — builder-util-runtime

  • Feat(win): export windowsPowerShellPath(), which returns the absolute path of the in-box Windows PowerShell (%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe) for runtime use such as electron-updater, and throws when SystemRoot is not a drive-absolute path. preparePowerShellExec and prepareAuthenticodeSignatureExec take an optional PowerShell path, ...

Read more

electron-builder@27.0.0-alpha.13

Pre-release

Choose a tag to compare

@electron-builder-release-bot electron-builder-release-bot released this 26 Oct 12:38
Immutable release. Only release title and notes can be modified.
04262af

Major Changes

  • Feat(win)!: a missing publisherName fails Windows update signature verification closed. #10380 674e18d — electron-builder, app-builder-lib, builder-util-runtime

    • electron-updater: an NSIS update is rejected with ERR_UPDATER_INVALID_SIGNATURE when app-update.yml (or dev-app-update.yml / the updateConfigPath file) has no publisherName. A custom verifyUpdateFileAuthenticodeSignature / verifyUpdateCodeSignature is never called without a publisherName. The only opt-out is verifyUpdateCodeSignature: false in app-update.yml, which electron-builder writes for win.verifyUpdateCodeSignature: false; verification is then skipped with one warning per updater. An app with no update config file at all (no app-update.yml / dev-app-update.yml, e.g. one that only uses setFeedURL) is not verified: its feed is configured by the developer.
    • app-builder-lib: a Windows build that writes app-update.yml (nsis, nsis-web or electronUpdaterAware appx with a publish configuration of any provider, including one inferred from a GitHub repository) fails with InvalidConfigurationError while win.verifyUpdateCodeSignature is enabled and no publisherName resolves: win.sign: false / null, no code signing certificate, or win.sign.publisherName: null, which is not an opt-out. Sign the build, set win.sign.publisherName (e.g. win.sign: { type: "signtool", publisherName: [...] } when signing outside electron-builder), or set win.verifyUpdateCodeSignature: false, which writes verifyUpdateCodeSignature: false (and no publisherName) into app-update.yml. A publisherName in the publish configuration must be a distinguished name too, and verifyUpdateCodeSignature must not be set there.
    • builder-util-runtime: PublishConfiguration has the private, Windows-only verifyUpdateCodeSignature field.
    • electron-builder: migrate-schema prints an advisory for win.sign: false / null or win.sign.publisherName: null without win.verifyUpdateCodeSignature: false.

    See https://www.electron.build/docs/migration/v27-build-changes#missing-publishername-fails-update-verification

  • Feat(win)!: require every publisherName entry to be a distinguished name (DN) (e.g. "CN=My Company, O=My Company, C=US"). An explicit win.sign.publisherName with an entry that is not a DN (e.g. a bare name) now fails the build with InvalidConfigurationError on every signing route (signtool, hsm, pkcs11, a custom sign hook, azure) before anything is signed, because electron-updater 7 never matches such an entry; publisherName: null still opts out. Without publisherName, the build now writes CN=<common name> of the certificate to app-update.yml instead of the bare Common Name, with the value quoted the way Windows quotes it in the subject electron-updater matches against, so a renewed certificate with the same CN keeps updates working (set a fuller DN explicitly for a stricter pin); the build-time checks of an explicit publisherName read the subject in the format Windows reports it (e.g. S= for the state). electron-builder migrate-schema prints an advisory for an entry that is not a DN. See https://www.electron.build/docs/migration/v27-build-changes#windows-publishername-must-be-a-distinguished-name #10380 674e18d — app-builder-lib

  • Feat(win)!: matchPublisherName matches only publisher names that are a distinguished name (DN), every attribute of which must equal the signer's; a bare name never matches the signer's Common Name any more, and its logger parameter is removed. New export isValidPublisherNameDn tells whether a publisher name is a DN. See https://www.electron.build/docs/migration/v27-build-changes#windows-publishername-must-be-a-distinguished-name #10380 674e18d — builder-util-runtime

  • Feat(signing)!: forceCodeSigning verifies signatures and fails when notarization, update-manifest signing or any signing step is skipped (also on pull-request builds), signed update manifests are read back before they are written, and the new electron-builder verify command checks built output (#10429). See https://www.electron.build/docs/migration/v27-build-changes#forcecodesigning-covers-notarization-and-update-manifests #10440 046f936 — electron-builder, app-builder-lib, dmg-builder

  • Feat(mac)!: mac.notarize: true requires notarization: a build without notarization credentials fails with an InvalidConfigurationError, at build start on a macOS host and when notarizing. Left unset, notarization runs when the credentials are set and is skipped with a warning otherwise. See https://www.electron.build/docs/migration/v27-build-changes#mac-notarize-true-requires-credentials #10444 145b373 — app-builder-lib

  • Feat(publish)!: electron-builder publish -f checks every update manifest (latest*.yml) before it uploads anything: an unsigned manifest is refused unless updateManifest: false, and with updateManifest.publicKey set the manifest must be signed by one of those keys (another key only with allowSigningKeyOutsideTrustList, which warns). Without publicKey it warns, and fails under forceCodeSigning. See https://www.electron.build/docs/migration/v27-build-changes#signed-update-manifests-are-required #10444 145b373 — electron-builder, app-builder-lib

  • Feat(squirrel)!: squirrelWindows.msi: true warns that the MSI Squirrel.Windows builds embeds Setup.exe before electron-builder signs it, and fails under forceCodeSigning, pointing at the msi target for a signed MSI. See https://www.electron.build/docs/migration/v27-build-changes#forcecodesigning-covers-notarization-and-update-manifests #10444 145b373 — app-builder-lib, electron-builder-squirrel-windows

  • Refactor(win)!: remove the escapePowerShellSingleQuotes export, which only shipped in 10.0.0-alpha.11; the Authenticode check passes the file path to PowerShell in an environment variable (prepareAuthenticodeSignatureExec), so no path is quoted into a PowerShell script. #10453 ed05bd0 — builder-util-runtime

Minor Changes

  • Feat: warn on silently skipped update signature verification and validate publisherName against the signing certificate at build time #10056 331afdd — app-builder-lib · updated in #10380

    Two guards around Windows update signature verification:

    • electron-updater: when app-update.yml exists but contains no publisherName, the updater used to skip signature verification (including custom verifyUpdateCodeSignature hooks) completely silently. It now logs a warning explaining that verification was skipped, how to fix it (sign the build so publisherName is derived automatically, or set win.publisherName explicitly), and that this fail-open behavior is deprecated. Since v27 (electron-updater 7), a missing publisherName in an existing app-update.yml is a verification failure (fail-closed) instead, unless the file has verifyUpdateCodeSignature: false. The no-app-update.yml path (unpackaged/dev mode) stays silent.
    • app-builder-lib: when publisherName is explicitly configured and the subject of the local code signing certificate is known, the build now fails with a clear error if none of the configured names match the certificate (same DN-subset/CN matching semantics as the updater's verifier; any one of multiple configured names matching passes, so certificate-rotation setups keep working). This catches signing with the wrong certificate at build time instead of at update time. The check is skipped whenever the actual signing certificate's subject is not genuinely known (custom sign hooks, Azure Trusted Signing, PKCS#11 without an extractable certificate, x509 files without a CN), and publisherName: null remains a pure opt-out.
  • Feat(updater)!: Windows update signature verification fails closed — electron-updater installs an NSIS update only when PowerShell (Get-AuthenticodeSignature) verifies it: an update it cannot verify (PowerShell cannot be started or run, times out, or prints unreadable output) is rejected with ERR_UPDATER_SIGNATURE_UNVERIFIABLE, and a Windows catalog signature is rejected as invalid unless the app opts in with the new NsisUpdater.allowCatalogSignature (default false; when true, a valid catalog ...

Read more

electron-updater@7.0.0-alpha.11

Pre-release

Choose a tag to compare

@electron-builder-release-bot electron-builder-release-bot released this 24 Oct 05:01
Immutable release. Only release title and notes can be modified.
b699499

Minor Changes

  • Feat(s3)!: explicit AWS credential sources for S3 publishing via the new awsCredentials option (restores shared config / IAM Identity Center profiles, #10054) #10257 46be1f4 — builder-util-runtime

    • awsCredentials.source is required to publish (no default, no implicit credentials).
    • awsCredentials.source: "env" reads only AWS_ACCESS_KEY_ID / AWS_SECRET_ACCESS_KEY / AWS_SESSION_TOKEN, or the variable names given in awsCredentials.env.
    • awsCredentials.source: "profile" with profile (plus optional credentialsFile / configFile) reads a named profile from the shared config and credentials files: static keys, IAM Identity Center (SSO), credential_process and assume-role. The AWS SDK providers are loaded lazily, only for non-static profiles, and are given explicit paths. Assume-role hops use an explicitly configured STS client (named profile's region, no configured endpoint URLs). credential_source and web identity (web_identity_token_file) are rejected anywhere in the chain, before the SDK is loaded.
    • awsCredentials.source: "sso-role-chain" with profile resolves an assume-role profile whose source_profile chain (up to 5 hops, no cycles) starts at an IAM Identity Center (SSO) profile: the SSO profile is resolved from the configured files, then STS AssumeRole is called per hop with explicit region, endpoint and credentials (never AWS_REGION, AWS_PROFILE or AWS_ENDPOINT_URL*). credential_source, mfa_serial, web identity and credential_process are rejected in the chain. source: "profile" keeps rejecting SSO-sourced role chains and points to this source.
    • Resolved credentials are reused for every file of a publish instead of being resolved again per upload.

    BREAKING CHANGE: S3 publishing fails with an InvalidConfigurationError unless awsCredentials.source is set (add { "source": "env" } to keep using AWS_ACCESS_KEY_ID / AWS_SECRET_ACCESS_KEY). AWS_PROFILE, AWS_SDK_LOAD_CONFIG, AWS_CONFIG_FILE, AWS_SHARED_CREDENTIALS_FILE and an implicit ~/.aws/credentials are no longer read. Missing credentials now fail with a clear error instead of an unsigned or env-fallback signature. For dotted bucket names without region, the region is looked up only when publishing. awsCredentials is never written to app-update.yml.

Patch Changes

  • Fix: enforce the configured API redirect limit without an extra hop #10121 8b71ed8 — builder-util-runtime
  • Refactor(updater): split GitHubProvider.getLatestVersion into helpers (internal refactor, no behavior change) #10290 4705c20
  • Fix: close embedded blockmap files exactly once on parse failures #10120 3bbc563
  • Fix(nsis): don't plan a differential download against a cached block map of another release. The cached block map is replaced when a download finishes, but the cached installer only when the update is installed, so a release found before the previous one was installed was planned against the wrong base: every differential byte was downloaded, the sha512 check failed, and the full installer was downloaded too. A cached block map that does not end at the cached installer's size is now ignored and the installed version's block map is fetched from the server. #10337 9ebb992
  • Fix(updater): treat channel "latest" as stable-only when allowPrerelease is enabled #10360 a3c9240
  • Fix(updater): download differentially when the update manifest has a hex-encoded sha512, never let a throwing logger stop a differential download or its fallback to a full download, time out stalled requests made with Electron's net module, and close the partially written file when a download's response fails or is aborted mid-body #10366 538aef4 — electron-updater, builder-util-runtime
  • Refactor(win): export the Windows Authenticode helpers electron-updater verifies update signatures with (preparePowerShellExec, escapePowerShellSingleQuotes, parseAuthenticodeSignatureOutput, matchPublisherName), moved unchanged from electron-updater so electron-builder can check signed installers with the same code #10378 60e3708 — builder-util-runtime
  • Refactor(win): verify update signatures with the Authenticode helpers moved unchanged to builder-util-runtime (no behavior change) #10378 60e3708
  • Fix: preserve complete XML text and reject incomplete documents #10125 45d3bc4 — builder-util-runtime
  • Fix: report finite transfer rates for immediate downloads #10122 370d18c — builder-util-runtime
  • Fix: when a server rejects multi-range requests (GitHub release assets answer 501, Google Cloud Storage 400, S3 the whole file with 200), retry the differential download with one range per request instead of downloading the full update. Every range response must now be a 206 for exactly the requested range: a host that ignores ranges used to stream the whole file once per range before the checksum failed, and now fails on its first request and falls back to a full download. #10343 0fdce73
  • Fix: installing an AppImage update no longer deletes the installed app before the new one is in place. Before, the updater deleted the running AppImage and then ran mv through PATH; if mv failed (for example spawnSync mv ENOTCONN when a dead AppImage FUSE mount from an earlier launch was on PATH), the user was left with no app to launch. After, the new AppImage is staged next to the old one and atomically renamed over it without running any external command, so a failed install keeps the old AppImage. #10386 8512f4d

electron-builder@27.0.0-alpha.12

Pre-release

Choose a tag to compare

@electron-builder-release-bot electron-builder-release-bot released this 24 Oct 05:01
Immutable release. Only release title and notes can be modified.
b699499

Major Changes

  • Feat!: add fileOptions.excludedExts (root and per platform, a list or a single string such as -c.fileOptions.excludedExts=default) to configure the file extensions excluded from the app files and the copied node_modules — "default" is the built-in list, which now includes pdb, any other entry adds an extension, and "!ext" removes one (a list of removals only, such as ["!pdb"], is rejected: write ["default", "!pdb"]; an invalid list fails the build when the configuration is validated, at the root and in every platform section); a later layer's list replaces an earlier one instead of being merged with it (extends child, programmatic or -c configuration, platform section, mas / masDev); a files pattern that names an excluded extension (e.g. native/addon.pdb) re-includes only the files it matches. BREAKING: removed the includePdb option — electron-builder migrate-schema rewrites includePdb: true to "fileOptions": { "excludedExts": ["default", "!pdb"] } and includePdb: false to "fileOptions": { "excludedExts": ["default"] }. #10339 0b508ab — electron-builder, app-builder-lib, builder-util

  • Feat(s3)!: explicit AWS credential sources for S3 publishing via the new awsCredentials option (restores shared config / IAM Identity Center profiles, #10054) #10257 46be1f4 — app-builder-lib, builder-util-runtime, electron-publish

    • awsCredentials.source is required to publish (no default, no implicit credentials).
    • awsCredentials.source: "env" reads only AWS_ACCESS_KEY_ID / AWS_SECRET_ACCESS_KEY / AWS_SESSION_TOKEN, or the variable names given in awsCredentials.env.
    • awsCredentials.source: "profile" with profile (plus optional credentialsFile / configFile) reads a named profile from the shared config and credentials files: static keys, IAM Identity Center (SSO), credential_process and assume-role. The AWS SDK providers are loaded lazily, only for non-static profiles, and are given explicit paths. Assume-role hops use an explicitly configured STS client (named profile's region, no configured endpoint URLs). credential_source and web identity (web_identity_token_file) are rejected anywhere in the chain, before the SDK is loaded.
    • awsCredentials.source: "sso-role-chain" with profile resolves an assume-role profile whose source_profile chain (up to 5 hops, no cycles) starts at an IAM Identity Center (SSO) profile: the SSO profile is resolved from the configured files, then STS AssumeRole is called per hop with explicit region, endpoint and credentials (never AWS_REGION, AWS_PROFILE or AWS_ENDPOINT_URL*). credential_source, mfa_serial, web identity and credential_process are rejected in the chain. source: "profile" keeps rejecting SSO-sourced role chains and points to this source.
    • Resolved credentials are reused for every file of a publish instead of being resolved again per upload.

    BREAKING CHANGE: S3 publishing fails with an InvalidConfigurationError unless awsCredentials.source is set (add { "source": "env" } to keep using AWS_ACCESS_KEY_ID / AWS_SECRET_ACCESS_KEY). AWS_PROFILE, AWS_SDK_LOAD_CONFIG, AWS_CONFIG_FILE, AWS_SHARED_CREDENTIALS_FILE and an implicit ~/.aws/credentials are no longer read. Missing credentials now fail with a clear error instead of an unsigned or env-fallback signature. For dotted bucket names without region, the region is looked up only when publishing. awsCredentials is never written to app-update.yml.

  • Feat(signing)!: fail the build when the signing key isn't in updateManifest.publicKey #10350 6e3153b — electron-builder, app-builder-lib

    BREAKING CHANGE: when updateManifest.publicKey is set explicitly and none of the keys the build signs update
    manifests with is in it, a publishing build now fails at build start, before anything is packed or uploaded, with an
    InvalidConfigurationError naming the key ids of the signing keys and of the listed keys (never key material). Such
    a release embeds no key it is signed with, so its installs would reject manifests signed with the current key(s).
    This was a warning before; a build without a publish policy still only warns. For a deliberate cutover release that
    is signed with the old key but embeds only the new one, set the new updateManifest.allowSigningKeyOutsideTrustList: true (explicit config only) to keep the warning. Nothing changes when publicKey is not set, since the trust list is
    then derived from the signing keys. See the v27 breaking changes guide.

  • Feat(signing)!: ELECTRON_BUILDER_UPDATE_SIGN_KEY takes the PEM file base64-encoded on one line, so CI systems such as GitLab can mask it (#10344) — encode it with base64 < update-private-key.pem | tr -d '\n', and for key rotation concatenate the PEM files and encode them once (cat old.pem new.pem | base64 | tr -d '\n'). BREAKING for the 27.0.0 alphas: a raw PEM, or any value that is not the standard base64 of complete PEM private keys (quoted, URL-safe, truncated, separately encoded keys joined together), now fails with an InvalidConfigurationError that never prints the value, and invalid or duplicate signing keys from any source are reported as an InvalidConfigurationError too; ELECTRON_BUILDER_UPDATE_SIGN_KEY_FILE and updateManifest.signingKey / signingKeyFile still take PEM, and electron-builder create-update-key prints the encode command for the key file it writes. #10347 f8a6719 — electron-builder, app-builder-lib, builder-util

Minor Changes

  • Fix(forge): make the electron-forge-maker-* packages loadable by Electron Forge 6+ (MakerBase-compatible default export class, also exported by name, with the maker config applied as the target's options); calling the default export as an Electron Forge 5 maker function still works #10351 1e32919 — app-builder-lib, electron-forge-maker-appimage, electron-forge-maker-nsis, electron-forge-maker-nsis-web, electron-forge-maker-snap
  • Feat(mac): APPLE_API_KEY also accepts the App Store Connect API key's .p8 contents base64-encoded on one line, so masked CI variables can hold it (#10344) — electron-builder writes it to a new 0600 temporary file for each notarization and deletes it once notarytool is done; a path keeps working unchanged, and key text (PEM) or a damaged base64 value now fails before notarization with an InvalidConfigurationError that does not print the key. The notarization guide documented base64 content before it was supported. #10347 f8a6719 — app-builder-lib
  • Feat(mac): embed the Electron 41+ ASAR integrity digest into the Electron Framework (signed again ad hoc afterwards), so with the enableEmbeddedAsarIntegrityValidation fuse the ElectronAsarIntegrity hashes in Info.plist can't be changed to match a modified app.asar; on by default, mac.asarIntegrityDigest: false opts out (#9648) #10346 4cd8a92 — app-builder-lib
  • Feat(mac): add a pkgDistributionCreated hook (#10355), mirroring appxManifestCreated and msiProjectCreated. It is called with the path to the PKG target's distribution.xml after electron-builder has written it and before productbuild builds the installer from it, so the distribution (for example, its <title>) can be edited in place or replaced. #10402 09dae73 — app-builder-lib

Patch Changes

  • Fix: deduplicate publish tasks by value #10134 48c0645
  • Fix: enforce the configured API redirect limit without an extra hop #10121 8b71ed8 — builder-util-runtime
  • Fix(publish): detect aborted S3 responses via close instead of the deprecated aborted event, and report non-http(s) or unparseable S3 endpoints as configuration errors #10349 9e0137e — electron-publish
  • Fix(signing): a base64 CSC_LINK / WIN_CSC_LINK / CSC_INSTALLER_LINK / SNAP_CSC_LINK / cscLink value must be valid standard base64 (line breaks are ignored; encode it with base64 -w0 or openssl base64 -A) — a value with surrounding quotes, URL-safe characte...
Read more
⌂ 换网址