Any macOS Target

The top-level mac key contains set of options instructing electron-builder on how it should build macOS targets. These options applicable for any macOS target.

MacConfiguration

undefined

  • category String | “undefined” - The application category type, as shown in the Finder via View -> Arrange by Application Category when viewing the Applications directory.

    For example, "category": "public.app-category.developer-tools" will set the application category to Developer Tools.

    Valid values are listed in Apple’s documentation.

  • target String | TargetConfiguration - The target package type: list of default, dmg, mas, mas-dev, pkg, 7z, zip, tar.xz, tar.lz, tar.gz, tar.bz2, dir. Defaults to default (dmg and zip for Squirrel.Mac). Note: Squirrel.Mac auto update mechanism requires both dmg and zip to be enabled, even when only dmg is used. Disabling zip will break auto update in dmg packages.

  • identity String | “undefined” - The name of certificate to use when signing. Consider using environment variables CSC_LINK or CSC_NAME instead of specifying this option. MAS installer identity is specified in the mas.

  • icon = build/icon.icns String | “undefined” - The path to application icon.

  • entitlements String | “undefined” - The path to entitlements file for signing the app. build/entitlements.mac.plist will be used if exists (it is a recommended way to set). MAS entitlements is specified in the mas. See this folder in osx-sign’s repository for examples. Be aware that your app may crash if the right entitlements are not set like com.apple.security.cs.allow-jit for example on arm64 builds with Electron 20+. See Signing and Notarizing macOS Builds from the Electron documentation for more information.

  • entitlementsInherit String | “undefined” - The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. build/entitlements.mac.inherit.plist will be used if exists (it is a recommended way to set). See this folder in osx-sign’s repository for examples.

    This option only applies when signing with entitlements provided.

  • entitlementsLoginHelper String | “undefined” - Path to login helper entitlement file. When using App Sandbox, the the com.apple.security.inherit key that is normally in the inherited entitlements cannot be inherited since the login helper is a standalone executable. Defaults to the value provided for entitlements. This option only applies when signing with entitlements provided.

  • provisioningProfile String | “undefined” - The path to the provisioning profile to use when signing, absolute or relative to the app root.

  • bundleVersion String | “undefined” - The CFBundleVersion. Do not use it unless you need to.

  • bundleShortVersion String | “undefined” - The CFBundleShortVersionString. Do not use it unless you need to.

  • darkModeSupport = false Boolean - Whether a dark mode is supported. If your app does have a dark mode, you can make your app follow the system-wide dark mode setting.

  • helperBundleId = ${appBundleIdentifier}.helper String | “undefined” - The bundle identifier to use in the application helper’s plist.

  • helperRendererBundleId = ${appBundleIdentifier}.helper.Renderer String | “undefined” - The bundle identifier to use in the Renderer helper’s plist.

  • helperPluginBundleId = ${appBundleIdentifier}.helper.Plugin String | “undefined” - The bundle identifier to use in the Plugin helper’s plist.

  • helperGPUBundleId = ${appBundleIdentifier}.helper.GPU String | “undefined” - The bundle identifier to use in the GPU helper’s plist.

  • helperEHBundleId = ${appBundleIdentifier}.helper.EH String | “undefined” - The bundle identifier to use in the EH helper’s plist.

  • helperNPBundleId = ${appBundleIdentifier}.helper.NP String | “undefined” - The bundle identifier to use in the NP helper’s plist.

  • type = distribution “distribution” | “development” | “undefined” - Whether to sign app for development or for distribution.

  • extendInfo any - The extra entries for Info.plist.

  • binaries Array<String> | “undefined” - Paths of any extra binaries that need to be signed.

  • minimumSystemVersion String | “undefined” - The minimum version of macOS required for the app to run. Corresponds to LSMinimumSystemVersion.

  • requirements String | “undefined” - Path of requirements file used in signing. Not applicable for MAS.

  • extraDistFiles Array<String> | String | “undefined” - Extra files to put in archive. Not applicable for tar.*.

  • hardenedRuntime = true Boolean - Whether your app has to be signed with hardened runtime.

  • gatekeeperAssess = false Boolean - Whether to let @electron/osx-sign validate the signing or not.

  • strictVerify = true Boolean - Whether to let @electron/osx-sign verify the contents or not.

  • preAutoEntitlements = true Boolean - Whether to enable entitlements automation from @electron/osx-sign.

  • signIgnore Array<String> | String | “undefined” - Regex or an array of regex’s that signal skipping signing a file.

  • sign module:app-builder-lib/out/macPackager.__type | String | “undefined” - The custom function (or path to file or module id) to sign an app bundle.

  • timestamp String | “undefined” - Specify the URL of the timestamp authority server

  • mergeASARs = true Boolean - Whether to merge ASAR files for different architectures or not.

    This option has no effect unless building for “universal” arch.

  • singleArchFiles String | “undefined” - Minimatch pattern of paths that are allowed to be present in one of the ASAR files, but not in the other.

    This option has no effect unless building for “universal” arch and applies only if mergeASARs is true.

  • x64ArchFiles String | “undefined” - Minimatch pattern of paths that are allowed to be x64 binaries in both ASAR files

    This option has no effect unless building for “universal” arch and applies only if mergeASARs is true.

  • notarize NotarizeLegacyOptions | NotarizeNotaryOptions | Boolean | “undefined” - Options to use for @electron/notarize (ref: https://github.com/electron/notarize). Supports both legacy and notarytool notarization tools. Use false to explicitly disable

    Note: In order to activate the notarization step You MUST specify one of the following via environment variables: 1. APPLE_API_KEY, APPLE_API_KEY_ID and APPLE_API_ISSUER. 2. APPLE_ID and APPLE_APP_SPECIFIC_PASSWORD 3. APPLE_KEYCHAIN and APPLE_KEYCHAIN_PROFILE

    For security reasons it is recommended to use the first option (see https://github.com/electron-userland/electron-builder/issues/7859)

NotarizeLegacyOptions

undefined

  • appBundleId String | “undefined” - The app bundle identifier your Electron app is using. E.g. com.github.electron. Useful if notarization ID differs from app ID (unlikely). Only used by legacy notarization tool
  • ascProvider String | “undefined” - Your Team Short Name. Only used by legacy notarization tool

NotarizeNotaryOptions

undefined

  • teamId String - The team ID you want to notarize under for when using notarytool

And all common platform-specific options.