Skip to content

Commit

Permalink
chore(docs): Add details to entitlement option in documentation for m…
Browse files Browse the repository at this point in the history
…acOS configurations (#7050) (#7097)
  • Loading branch information
AxelTerizaki committed Aug 31, 2022
1 parent cd21b09 commit e78a65c
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
5 changes: 5 additions & 0 deletions .changeset/green-buses-beg.md
@@ -0,0 +1,5 @@
---
"app-builder-lib": patch
---

chore: Add documentation details to entitlement option for macOS configurations
11 changes: 8 additions & 3 deletions packages/app-builder-lib/src/options/macOptions.ts
Expand Up @@ -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.
*/
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit e78a65c

Please sign in to comment.