diff --git a/.changeset/big-rice-sneeze.md b/.changeset/big-rice-sneeze.md new file mode 100644 index 00000000000..8a98d14c284 --- /dev/null +++ b/.changeset/big-rice-sneeze.md @@ -0,0 +1,5 @@ +--- +"app-builder-lib": patch +--- + +docs: update notarization docs in schema diff --git a/docs/configuration/mac.md b/docs/configuration/mac.md index 4dd3f120f7b..793bcd65c58 100644 --- a/docs/configuration/mac.md +++ b/docs/configuration/mac.md @@ -106,7 +106,7 @@ The top-level [mac](configuration.md#Configuration-mac) key contains set of opti
  • notarize module:app-builder-lib/out/options/macOptions.NotarizeLegacyOptions | module:app-builder-lib/out/options/macOptions.NotarizeNotaryOptions | Boolean | “undefined” - Options to use for @electron/notarize (ref: https://github.com/electron/notarize). Supports both legacy and notarytool notarization tools. Use false to explicitly disable

    -

    Note: You MUST specify APPLE_ID and APPLE_APP_SPECIFIC_PASSWORD via environment variables to activate notarization step

    +

    Note: In order to activate the notarization step You MUST specify one of the following via environment variables:\n1. APPLE_API_KEY, APPLE_API_KEY_ID and APPLE_API_ISSUER\n2. APPLE_ID and APPLE_APP_SPECIFIC_PASSWORD\n3. APPLE_KEYCHAIN and APPLE_KEYCHAIN_PROFILE\n\nFor security reasons it is recommended to use the first option (see https://github.com/electron-userland/electron-builder/issues/7859)

  • diff --git a/packages/app-builder-lib/scheme.json b/packages/app-builder-lib/scheme.json index d6289035a32..3955f313288 100644 --- a/packages/app-builder-lib/scheme.json +++ b/packages/app-builder-lib/scheme.json @@ -2680,7 +2680,7 @@ ] } ], - "description": "Options to use for @electron/notarize (ref: https://github.com/electron/notarize).\nSupports both `legacy` and `notarytool` notarization tools. Use `false` to explicitly disable\n\nNote: You MUST specify `APPLE_ID` and `APPLE_APP_SPECIFIC_PASSWORD` via environment variables to activate notarization step" + "description": "Options to use for @electron/notarize (ref: https://github.com/electron/notarize).\nSupports both `legacy` and `notarytool` notarization tools. Use `false` to explicitly disable\n\nNote: In order to activate the notarization step You MUST specify one of the following via environment variables:\\n1. `APPLE_API_KEY`, `APPLE_API_KEY_ID` and `APPLE_API_ISSUER`\\n2. `APPLE_ID` and `APPLE_APP_SPECIFIC_PASSWORD`\\n3. `APPLE_KEYCHAIN` and `APPLE_KEYCHAIN_PROFILE`\\n\\nFor security reasons it is recommended to use the first option (see https://github.com/electron-userland/electron-builder/issues/7859)" }, "preAutoEntitlements": { "default": true, @@ -3313,7 +3313,7 @@ ] } ], - "description": "Options to use for @electron/notarize (ref: https://github.com/electron/notarize).\nSupports both `legacy` and `notarytool` notarization tools. Use `false` to explicitly disable\n\nNote: You MUST specify `APPLE_ID` and `APPLE_APP_SPECIFIC_PASSWORD` via environment variables to activate notarization step" + "description": "Options to use for @electron/notarize (ref: https://github.com/electron/notarize).\nSupports both `legacy` and `notarytool` notarization tools. Use `false` to explicitly disable\n\nNote: In order to activate the notarization step You MUST specify one of the following via environment variables:\\n1. `APPLE_API_KEY`, `APPLE_API_KEY_ID` and `APPLE_API_ISSUER`\\n2. `APPLE_ID` and `APPLE_APP_SPECIFIC_PASSWORD`\\n3. `APPLE_KEYCHAIN` and `APPLE_KEYCHAIN_PROFILE`\\n\\nFor security reasons it is recommended to use the first option (see https://github.com/electron-userland/electron-builder/issues/7859)" }, "preAutoEntitlements": { "default": true, diff --git a/packages/app-builder-lib/src/options/macOptions.ts b/packages/app-builder-lib/src/options/macOptions.ts index 607f6515c95..3ec301b9bcf 100644 --- a/packages/app-builder-lib/src/options/macOptions.ts +++ b/packages/app-builder-lib/src/options/macOptions.ts @@ -210,7 +210,7 @@ export interface MacConfiguration extends PlatformSpecificBuildOptions { * Options to use for @electron/notarize (ref: https://github.com/electron/notarize). * Supports both `legacy` and `notarytool` notarization tools. Use `false` to explicitly disable * - * Note: You MUST specify `APPLE_ID` and `APPLE_APP_SPECIFIC_PASSWORD` via environment variables to activate notarization step + * Note: In order to activate the notarization step You MUST specify one of the following via environment variables:\n1. `APPLE_API_KEY`, `APPLE_API_KEY_ID` and `APPLE_API_ISSUER`\n2. `APPLE_ID` and `APPLE_APP_SPECIFIC_PASSWORD`\n3. `APPLE_KEYCHAIN` and `APPLE_KEYCHAIN_PROFILE`\n\nFor security reasons it is recommended to use the first option (see https://github.com/electron-userland/electron-builder/issues/7859) */ readonly notarize?: NotarizeLegacyOptions | NotarizeNotaryOptions | boolean | null }