Skip to content

Commit

Permalink
fix: resolve CI/CD docs generation issue (#8281)
Browse files Browse the repository at this point in the history
  • Loading branch information
mmaietta authored Jun 29, 2024
1 parent 88bbbdb commit 9a0b3c6
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 35 deletions.
5 changes: 5 additions & 0 deletions .changeset/sour-mugs-greet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"app-builder-lib": patch
---

fix: resolve CI/CD docs generation issue and update schema
8 changes: 1 addition & 7 deletions docs/configuration/mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,17 +114,11 @@ The top-level [mac](configuration.md#Configuration-mac) key contains set of opti
<p>Some subresources that you may include in your Electron app may need to be signed with --deep, this is not typically safe to apply to the entire Electron app and therefore should be applied to just your file. Usage Example: <code>['--deep']</code></p>
</li>
<li>
<p><code id="MacConfiguration-notarize">notarize</code> <a href="#NotarizeLegacyOptions">NotarizeLegacyOptions</a> | <a href="#NotarizeNotaryOptions">NotarizeNotaryOptions</a> | Boolean | “undefined” - Options to use for @electron/notarize (ref: <a href="https://github.com/electron/notarize">https://github.com/electron/notarize</a>). Use <code>false</code> to explicitly disable</p>
<p><code id="MacConfiguration-notarize">notarize</code> <a href="#NotarizeNotaryOptions">NotarizeNotaryOptions</a> | Boolean | “undefined” - Options to use for @electron/notarize (ref: <a href="https://github.com/electron/notarize">https://github.com/electron/notarize</a>). Use <code>false</code> to explicitly disable</p>
<p>Note: In order to activate the notarization step You MUST specify one of the following via environment variables: 1. <code>APPLE_API_KEY</code>, <code>APPLE_API_KEY_ID</code> and <code>APPLE_API_ISSUER</code>. 2. <code>APPLE_ID</code>, <code>APPLE_APP_SPECIFIC_PASSWORD</code>, and <code>APPLE_TEAM_ID</code> 3. <code>APPLE_KEYCHAIN</code> and <code>APPLE_KEYCHAIN_PROFILE</code></p>
<p>For security reasons it is recommended to use the first option (see <a href="https://github.com/electron-userland/electron-builder/issues/7859">https://github.com/electron-userland/electron-builder/issues/7859</a>)</p>
</li>
</ul>
<h2 id="notarizelegacyoptions">NotarizeLegacyOptions</h2>
<p>undefined</p>
<ul>
<li><code id="NotarizeLegacyOptions-appBundleId">appBundleId</code> 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 <code>legacy</code> notarization tool</li>
<li><code id="NotarizeLegacyOptions-ascProvider">ascProvider</code> String | “undefined” - Your Team Short Name. Only used by <code>legacy</code> notarization tool</li>
</ul>
<h2 id="notarizenotaryoptions">NotarizeNotaryOptions</h2>
<p>undefined</p>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"generate-schema": "typescript-json-schema packages/app-builder-lib/tsconfig-scheme.json Configuration --out packages/app-builder-lib/scheme.json --noExtraProps --useTypeOfKeyword --strictNullChecks --required && node ./scripts/fix-schema.js",
"generate-all": "pnpm generate-schema && pnpm generate-docs && pnpm prettier",
"ci:test": "node ./test/out/helpers/runTests.js",
"ci:version": "pnpm changelog && changeset version && node scripts/update-package-version-export.js && pnpm run compile && pnpm run generate-schema && pnpm run generate-docs && pnpm run prettier && git add .",
"ci:version": "pnpm changelog && changeset version && node scripts/update-package-version-export.js && pnpm run generate-all && git add .",
"ci:publish": "pnpm compile && pnpm publish -r && changeset tag",
"jsdoc": "ts2jsdoc packages/builder-util-runtime packages/builder-util packages/app-builder-lib packages/electron-builder packages/electron-publish packages/electron-updater packages/dmg-builder",
"jsdoc2md2html": "node scripts/jsdoc2md2html.js",
Expand Down
26 changes: 0 additions & 26 deletions packages/app-builder-lib/scheme.json
Original file line number Diff line number Diff line change
Expand Up @@ -2532,9 +2532,6 @@
},
"notarize": {
"anyOf": [
{
"$ref": "#/definitions/NotarizeLegacyOptions"
},
{
"$ref": "#/definitions/NotarizeNotaryOptions"
},
Expand Down Expand Up @@ -3165,9 +3162,6 @@
},
"notarize": {
"anyOf": [
{
"$ref": "#/definitions/NotarizeLegacyOptions"
},
{
"$ref": "#/definitions/NotarizeNotaryOptions"
},
Expand Down Expand Up @@ -3687,26 +3681,6 @@
},
"type": "object"
},
"NotarizeLegacyOptions": {
"additionalProperties": false,
"properties": {
"appBundleId": {
"description": "The app bundle identifier your Electron app is using. E.g. com.github.electron. Useful if notarization ID differs from app ID (unlikely).\nOnly used by `legacy` notarization tool",
"type": [
"null",
"string"
]
},
"ascProvider": {
"description": "Your Team Short Name. Only used by `legacy` notarization tool",
"type": [
"null",
"string"
]
}
},
"type": "object"
},
"NotarizeNotaryOptions": {
"additionalProperties": false,
"properties": {
Expand Down
1 change: 0 additions & 1 deletion scripts/jsdoc2md2html.js
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,6 @@ async function render2(files, jsdoc2MdOptions) {

new Page("configuration/mac.md", null, {
"MacConfiguration": "",
"NotarizeLegacyOptions" : "",
"NotarizeNotaryOptions" : ""
}),
new Page("configuration/dmg.md", "DmgOptions"),
Expand Down

0 comments on commit 9a0b3c6

Please sign in to comment.