Skip to content

feat: add writeUpdateInfo option for zip builds #9486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
beyondkmp wants to merge 4 commits into
base: master
Choose a base branch
from
Open

feat: add writeUpdateInfo option for zip builds #9486

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c0cd956
feat: add writeUpdateInfo option for macOS builds
beyondkmp Jan 7, 2026
329cad9
refactor: move writeUpdateInfo from MacConfiguration to target-specif…
beyondkmp Jan 16, 2026
c3d2a31
add changeset
beyondkmp Jan 16, 2026
5bdbe70
Merge branch 'master' into feat/mac-write-update-info
beyondkmp Jan 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions packages/app-builder-lib/scheme.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3080,6 +3080,10 @@
"default": "distribution",
"description": "Whether to sign app for development or for distribution."
},
"writeUpdateInfo": {
"default": true,
"type": "boolean"
},
"x64ArchFiles": {
"description": "Minimatch pattern of paths that are allowed to be x64 binaries in both\nASAR files\n\nThis option has no effect unless building for \"universal\" arch and applies\nonly if `mergeASARs` is `true`.",
"type": [
Expand Down Expand Up @@ -3715,6 +3719,10 @@
"default": "distribution",
"description": "Whether to sign app for development or for distribution."
},
"writeUpdateInfo": {
"default": true,
"type": "boolean"
},
"x64ArchFiles": {
"description": "Minimatch pattern of paths that are allowed to be x64 binaries in both\nASAR files\n\nThis option has no effect unless building for \"universal\" arch and applies\nonly if `mergeASARs` is `true`.",
"type": [
Expand Down
2 changes: 1 addition & 1 deletion packages/app-builder-lib/src/macPackager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ export class MacPackager extends PlatformPackager<MacConfiguration> {

case "zip":
// https://github.com/electron-userland/electron-builder/issues/2313
mapper(name, outDir => new ArchiveTarget(name, outDir, this, true))
mapper(name, outDir => new ArchiveTarget(name, outDir, this, this.platformSpecificBuildOptions.writeUpdateInfo ?? true))
break

case "pkg":
Expand Down
6 changes: 6 additions & 0 deletions packages/app-builder-lib/src/options/macOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,12 @@ export interface MacConfiguration extends PlatformSpecificBuildOptions {
* For security reasons it is recommended to use the first option (see https://github.com/electron-userland/electron-builder/issues/7859)
*/
readonly notarize?: boolean

/**
* @private
* @default true
*/
writeUpdateInfo?: boolean
Copy link

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The writeUpdateInfo property should be marked as readonly to maintain consistency with other optional properties in the MacConfiguration interface. All other optional properties in this interface use the readonly modifier.

Suggested change
writeUpdateInfo?: boolean
readonly writeUpdateInfo?: boolean

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation for this @private option lacks context about its purpose. Since this is a user-facing configuration option (even if marked private), it should include a description explaining what "update info" means and when a user might want to set this to false. Consider adding documentation similar to: "Whether to write update info files (blockmap) for zip archives. These files are used for differential updates."

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Collaborator

@mmaietta mmaietta Jan 8, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This applies to ALL mac targets, which isn't correct since that also includes pkg mas and dir targets, where this option would be irrelevant. I'm not sure I'm in favor of this approach

Copy link
Copy Markdown
Contributor Author

@beyondkmp beyondkmp Jan 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated. added zip options.

}

export interface DmgOptions extends TargetSpecificOptions {
Expand Down
Loading