Skip to content

Commit e78a65c

Browse files
authored
chore(docs): Add details to entitlement option in documentation for macOS configurations (#7050) (#7097)
1 parent cd21b09 commit e78a65c

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

.changeset/green-buses-beg.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"app-builder-lib": patch
3+
---
4+
5+
chore: Add documentation details to entitlement option for macOS configurations

packages/app-builder-lib/src/options/macOptions.ts

+8-3
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,15 @@ export interface MacConfiguration extends PlatformSpecificBuildOptions {
3232
/**
3333
* 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).
3434
* MAS entitlements is specified in the [mas](/configuration/mas).
35+
* See [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) for examples.
36+
* 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+.
37+
* 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.
3538
*/
3639
readonly entitlements?: string | null
3740

3841
/**
3942
* 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).
40-
* Otherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.darwin.inherit.plist).
43+
* See [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) for examples.
4144
*
4245
* This option only applies when signing with `entitlements` provided.
4346
*/
@@ -329,13 +332,15 @@ export interface DmgContent {
329332
export interface MasConfiguration extends MacConfiguration {
330333
/**
331334
* 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).
332-
* Otherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.plist).
335+
* See [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) for examples.
336+
* 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+.
337+
* 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.
333338
*/
334339
readonly entitlements?: string | null
335340

336341
/**
337342
* 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).
338-
* Otherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.inherit.plist).
343+
* See [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) for examples.
339344
*/
340345
readonly entitlementsInherit?: string | null
341346

0 commit comments

Comments
 (0)