Skip to content

Commit b363bcd

Browse files
author
Mike Maietta
committed
chore(docs): regenerating documentation and schema per new Configuration changes
1 parent e78a65c commit b363bcd

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

docs/configuration/mac.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ The top-level [mac](configuration.md#Configuration-mac) key contains set of opti
1717
<p><code id="MacConfiguration-icon">icon</code> = <code>build/icon.icns</code> String | “undefined” - The path to application icon.</p>
1818
</li>
1919
<li>
20-
<p><code id="MacConfiguration-entitlements">entitlements</code> String | “undefined” - The path to entitlements file for signing the app. <code>build/entitlements.mac.plist</code> will be used if exists (it is a recommended way to set). MAS entitlements is specified in the <a href="/configuration/mas">mas</a>.</p>
20+
<p><code id="MacConfiguration-entitlements">entitlements</code> String | “undefined” - The path to entitlements file for signing the app. <code>build/entitlements.mac.plist</code> will be used if exists (it is a recommended way to set). MAS entitlements is specified in the <a href="/configuration/mas">mas</a>. See <a href="https://github.com/electron/osx-sign/tree/main/entitlements">this folder in osx-sign’s repository</a> for examples. Be aware that your app may crash if the right entitlements are not set like <code>com.apple.security.cs.allow-jit</code> for example on arm64 builds with Electron 20+. See <a href="https://www.electronjs.org/docs/latest/tutorial/code-signing#signing--notarizing-macos-builds">Signing and Notarizing macOS Builds from the Electron documentation</a> for more information.</p>
2121
</li>
2222
<li>
23-
<p><code id="MacConfiguration-entitlementsInherit">entitlementsInherit</code> String | “undefined” - The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. <code>build/entitlements.mac.inherit.plist</code> will be used if exists (it is a recommended way to set). Otherwise <a href="https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.darwin.inherit.plist">default</a>.</p>
23+
<p><code id="MacConfiguration-entitlementsInherit">entitlementsInherit</code> String | “undefined” - The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. <code>build/entitlements.mac.inherit.plist</code> will be used if exists (it is a recommended way to set). See <a href="https://github.com/electron/osx-sign/tree/main/entitlements">this folder in osx-sign’s repository</a> for examples.</p>
2424
<p>This option only applies when signing with <code>entitlements</code> provided.</p>
2525
</li>
2626
<li>

docs/configuration/mas.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ Inherits [macOS options](mac.md).
33

44
<!-- do not edit. start of generated block -->
55
<ul>
6-
<li><code id="MasConfiguration-entitlements">entitlements</code> String | “undefined” - The path to entitlements file for signing the app. <code>build/entitlements.mas.plist</code> will be used if exists (it is a recommended way to set). Otherwise <a href="https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.plist">default</a>.</li>
7-
<li><code id="MasConfiguration-entitlementsInherit">entitlementsInherit</code> String | “undefined” - The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. <code>build/entitlements.mas.inherit.plist</code> will be used if exists (it is a recommended way to set). Otherwise <a href="https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.inherit.plist">default</a>.</li>
6+
<li><code id="MasConfiguration-entitlements">entitlements</code> String | “undefined” - The path to entitlements file for signing the app. <code>build/entitlements.mas.plist</code> will be used if exists (it is a recommended way to set). See <a href="https://github.com/electron/osx-sign/tree/main/entitlements">this folder in osx-sign’s repository</a> for examples. Be aware that your app may crash if the right entitlements are not set like <code>com.apple.security.cs.allow-jit</code> for example on arm64 builds with Electron 20+. See <a href="https://www.electronjs.org/docs/latest/tutorial/code-signing#signing--notarizing-macos-builds">Signing and Notarizing macOS Builds from the Electron documentation</a> for more information.</li>
7+
<li><code id="MasConfiguration-entitlementsInherit">entitlementsInherit</code> String | “undefined” - The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. <code>build/entitlements.mas.inherit.plist</code> will be used if exists (it is a recommended way to set). See <a href="https://github.com/electron/osx-sign/tree/main/entitlements">this folder in osx-sign’s repository</a> for examples.</li>
88
<li><code id="MasConfiguration-binaries">binaries</code> Array&lt;String&gt; | “undefined” - Paths of any extra binaries that need to be signed.</li>
99
</ul>
1010

packages/app-builder-lib/scheme.json

+6-6
Original file line numberDiff line numberDiff line change
@@ -2404,14 +2404,14 @@
24042404
]
24052405
},
24062406
"entitlements": {
2407-
"description": "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).\nMAS entitlements is specified in the [mas](/configuration/mas).",
2407+
"description": "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).\nMAS entitlements is specified in the [mas](/configuration/mas).\nSee [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) for examples.\nBe 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+.\nSee [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.",
24082408
"type": [
24092409
"null",
24102410
"string"
24112411
]
24122412
},
24132413
"entitlementsInherit": {
2414-
"description": "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).\nOtherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.darwin.inherit.plist).\n\nThis option only applies when signing with `entitlements` provided.",
2414+
"description": "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).\nSee [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) for examples.\n\nThis option only applies when signing with `entitlements` provided.",
24152415
"type": [
24162416
"null",
24172417
"string"
@@ -3022,14 +3022,14 @@
30223022
]
30233023
},
30243024
"entitlements": {
3025-
"description": "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).\nOtherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.plist).",
3025+
"description": "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).\nSee [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) for examples.\nBe 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+.\nSee [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.",
30263026
"type": [
30273027
"null",
30283028
"string"
30293029
]
30303030
},
30313031
"entitlementsInherit": {
3032-
"description": "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).\nOtherwise [default](https://github.com/electron-userland/electron-osx-sign/blob/master/default.entitlements.mas.inherit.plist).",
3032+
"description": "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).\nSee [this folder in osx-sign's repository](https://github.com/electron/osx-sign/tree/main/entitlements) for examples.",
30333033
"type": [
30343034
"null",
30353035
"string"
@@ -6316,14 +6316,14 @@
63166316
"type": "boolean"
63176317
},
63186318
"buildNumber": {
6319-
"description": "The build number. Maps to the `--iteration` flag for builds using FPM on Linux. If not defined then will fallback to `BUILD_NUMBER` or `TRAVIS_BUILD_NUMBER` or `APPVEYOR_BUILD_NUMBER` or `CIRCLE_BUILD_NUM` or `BUILD_BUILDNUMBER` or `CI_PIPELINE_IID` env.",
6319+
"description": "The build number. Maps to the `--iteration` flag for builds using FPM on Linux.\nIf not defined, then it will fallback to `BUILD_NUMBER` or `TRAVIS_BUILD_NUMBER` or `APPVEYOR_BUILD_NUMBER` or `CIRCLE_BUILD_NUM` or `BUILD_BUILDNUMBER` or `CI_PIPELINE_IID` env.",
63206320
"type": [
63216321
"null",
63226322
"string"
63236323
]
63246324
},
63256325
"buildVersion": {
6326-
"description": "The build version. Maps to the `CFBundleVersion` on macOS, and `FileVersion` metadata property on Windows. Defaults to the `version`.\nIf `buildVersion` is not defined and `buildNumber` (or one of the `buildNumber envs) is defined, it will be used as a build version (`version.buildNumber`).",
6326+
"description": "The build version. Maps to the `CFBundleVersion` on macOS, and `FileVersion` metadata property on Windows. Defaults to the `version`.\nIf `buildVersion` is not defined and `buildNumber` (or one of the `buildNumber` envs) is defined, it will be used as a build version (`version.buildNumber`).",
63276327
"type": [
63286328
"null",
63296329
"string"

0 commit comments

Comments
 (0)