From e78a65c46a55f794da2dd0d2f6e838f8421174b9 Mon Sep 17 00:00:00 2001 From: Axel Terizaki Date: Wed, 31 Aug 2022 17:35:11 +0200 Subject: [PATCH] chore(docs): Add details to entitlement option in documentation for macOS configurations (#7050) (#7097) --- .changeset/green-buses-beg.md | 5 +++++ packages/app-builder-lib/src/options/macOptions.ts | 11 ++++++++--- 2 files changed, 13 insertions(+), 3 deletions(-) create mode 100644 .changeset/green-buses-beg.md diff --git a/.changeset/green-buses-beg.md b/.changeset/green-buses-beg.md new file mode 100644 index 0000000000..26d87c9cc7 --- /dev/null +++ b/.changeset/green-buses-beg.md @@ -0,0 +1,5 @@ +--- +"app-builder-lib": patch +--- + +chore: Add documentation details to entitlement option for macOS configurations diff --git a/packages/app-builder-lib/src/options/macOptions.ts b/packages/app-builder-lib/src/options/macOptions.ts index 0077d8030f..c84bf6ef52 100644 --- a/packages/app-builder-lib/src/options/macOptions.ts +++ b/packages/app-builder-lib/src/options/macOptions.ts @@ -32,12 +32,15 @@ export interface MacConfiguration extends PlatformSpecificBuildOptions { /** * 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](/configuration/mas). + * See [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) 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](https://www.electronjs.org/docs/latest/tutorial/code-signing#signing--notarizing-macos-builds) for more information. */ readonly entitlements?: string | null /** * 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). - * Otherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.darwin.inherit.plist). + * See [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) for examples. * * This option only applies when signing with `entitlements` provided. */ @@ -329,13 +332,15 @@ export interface DmgContent { export interface MasConfiguration extends MacConfiguration { /** * The path to entitlements file for signing the app. `build/entitlements.mas.plist` will be used if exists (it is a recommended way to set). - * Otherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.plist). + * See [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) 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](https://www.electronjs.org/docs/latest/tutorial/code-signing#signing--notarizing-macos-builds) for more information. */ readonly entitlements?: string | null /** * The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. `build/entitlements.mas.inherit.plist` will be used if exists (it is a recommended way to set). - * Otherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.inherit.plist). + * See [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) for examples. */ readonly entitlementsInherit?: string | null