Trim PR to more minimal example

iffy · iffy · commit 99a4313d9eac · 2021-10-15T13:22:02.000-04:00
diff --git a/README.md b/README.md
@@ -5,17 +5,24 @@ If you can't use GitHub, you can use other providers:
 - [Complete electron-updater HTTP example](https://gist.github.com/iffy/0ff845e8e3f59dbe7eaf2bf24443f104)
 - [Complete electron-updater from gitlab.com private repo example](https://gist.github.com/Slauta/5b2bcf9fa1f6f6a9443aa6b447bcae05)
 
-**NOTE:** If you want to run through this whole process, you will need to fork this repo on GitHub and replace all instances of `iffy` with your GitHub username before doing the following steps.
+**NOTE:** If you want to run through this whole process, either fork this repo or [start your own from a template](https://github.com/iffy/electron-updater-example/generate). Then replace all instances of `iffy` with your GitHub username before doing the following steps.
 
 1. For macOS, you will need a code-signing certificate.
 
     Install Xcode (from the App Store), then follow [these instructions](https://developer.apple.com/library/content/documentation/IDEs/Conceptual/AppDistributionGuide/MaintainingCertificates/MaintainingCertificates.html#//apple_ref/doc/uid/TP40012582-CH31-SW6) to make sure you have a "Developer ID Application" certificate.  If you'd like to export the certificate (for automated building, for instance) [you can](https://developer.apple.com/library/content/documentation/IDEs/Conceptual/AppDistributionGuide/MaintainingCertificates/MaintainingCertificates.html#//apple_ref/doc/uid/TP40012582-CH31-SW7).  You would then follow [these instructions](https://www.electron.build/code-signing).
    
     This example application is set up to perform code-signing and notarization on Mac OS provided that a `Developer ID
     Application` certificate is installed in the default keychain.  The following environment variables are important for the signing process:
+
     - `CSC_IDENTITY_AUTO_DISCOVERY` - controls whether `electron-builder` tries to sign the application; default is `true`, set to `false` to skip signing
-    - `APPLEID` - the Apple ID to use for notarization (required for signing).
-    - `APPLEIDPASS` - the password to use with the specified Apple ID for notarization (required for signing).  Apple recommends setting up an app-specific password to safeguard the Apple ID password (see [Apple Support](https://support.apple.com/en-us/HT204397)) for more information.
+    - `APPLE_ID` - the Apple ID to use for notarization (required for signing).
+    - `APPLE_ID_PASSWORD` - the password to use with the specified Apple ID for notarization (required for signing).  Apple recommends setting up an app-specific password to safeguard the Apple ID password (see [Apple Support](https://support.apple.com/en-us/HT204397)) for more information.
+
+    To enable code-signing and notarization:
+
+        export CSC_IDENTITY_AUTO_DISCOVERY="true"
+        export APPLE_ID="<your Apple ID>"
+        export APPLE_ID_PASSWORD="<your Apple Password>"
 
 2. Adjust `package.json` if needed.
 
@@ -51,7 +58,7 @@ If you can't use GitHub, you can use other providers:
 
         [Environment]::SetEnvironmentVariable("GH_TOKEN","<YOUR_TOKEN_HERE>","User")
 
-    Make sure to restart IDE/Terminal to inherit latest env variable.
+    Make sure to restart your IDE/Terminal to inherit latest env variable.
 
 5. Publish for your platform with:
 
@@ -65,7 +72,7 @@ If you can't use GitHub, you can use other providers:
 
         ...
         "scripts": {
-            "publish": "build --mac --win -p always"
+            "publish": "electron-builder --mac --win -p always"
         },
         ...
 
diff --git a/build/entitlements.mac.plist b/build/entitlements.mac.plist
@@ -2,8 +2,6 @@
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
   <dict>
-    <key>com.apple.security.cs.debugger</key>
-    <true/>
     <key>com.apple.security.cs.allow-jit</key>
     <true/>
     <key>com.apple.security.cs.allow-unsigned-executable-memory</key>
diff --git a/build/notarize.js b/build/notarize.js
@@ -1,79 +1,30 @@
 const { notarize } = require('electron-notarize');
 const path = require('path');
-const fs = require('fs');
-const jsYaml = require('js-yaml');
-
-function findPackageJsonPath() {
-  let dirName = process.cwd();
-
-  while(dirName) {
-    const packageJsonFilePath = path.join(dirName, 'package.json');
-    if (fs.existsSync(packageJsonFilePath)) {
-      return packageJsonFilePath;
-    } else if (dirName === '/') {
-      break;
-    }
-    dirName = path.dirname(dirName);
-  }
-  return undefined;
-}
-
-function getAppId(context) {
-  // Try to get the appId from the packager
-  const config = context.packager.info._configuration;
-  if (config && config.appId) {
-    console.log('Found appId in packager');
-    return config.appId;
-  }
-
-  // Try to get the appId from the builder-effective-config.yml file
-  const builderEffectiveConfigPath = path.join(context.outDir, 'builder-effective-config.yaml');
-  if (fs.existsSync(builderEffectiveConfigPath)) {
-    const builderEffectiveConfigText = fs.readFileSync(builderEffectiveConfigPath);
-    const builderEffectiveConfig = jsYaml.load(builderEffectiveConfigText);
-    if (builderEffectiveConfig['appId']) {
-      console.log('Found appId in %s', builderEffectiveConfigPath);
-      return builderEffectiveConfig['appId'];
-    }
-  }
-
-  // Try to get the appId from the package.json file
-  const packageJsonFilePath = findPackageJsonPath();
-  if (packageJsonFilePath) {
-    try {
-      const packageJson = require(packageJsonFilePath);
-      if (packageJson['build'] && packageJson['build']['appId']) {
-        console.log('Found appId in %s', packageJsonFilePath);
-        return packageJson['build']['appId'];
-      }
-    } catch (err) {
-      // swallow the error
-      console.log('Failed to read %s: %s', packageJsonFilePath, err);
-    }
-  }
-
-  // finally, check the APP_ID environment variable
-  if (process.env.APP_ID) {
-    console.log('Found appId in APP_ID environment variable');
-    return process.env.APP_ID;
-  }
-  throw new Error('Unable to find the application ID');
-}
 
 exports.default = async function notarizing(context) {
-  const { electronPlatformName } = context;
-  if (electronPlatformName !== 'darwin' || process.env.CSC_IDENTITY_AUTO_DISCOVERY === 'false') {
+  if (context.electronPlatformName !== 'darwin' || process.env.CSC_IDENTITY_AUTO_DISCOVERY === 'false') {
+    console.log("Skipping notarization");
     return;
   }
+  console.log("Notarizing...")
 
-  const appId = getAppId(context);
+  const appBundleId = context.packager.appInfo.info._configuration.appId;
   const appName = context.packager.appInfo.productFilename;
-  const appPath = path.normalize(path.join(context.outDir, 'mac', `${appName}.app`));
-  console.log('calling notarize for appId = %s with appPath = %s', appId, appPath);
+  const appPath = path.normalize(path.join(context.appOutDir, `${appName}.app`));
+  const appleId = process.env.APPLE_ID;
+  const appleIdPassword = process.env.APPLE_ID_PASSWORD;
+  if (!appleId) {
+    console.warn("Not notarizing: Missing APPLE_ID environment variable");
+    return;
+  }
+  if (!appleIdPassword) {
+    console.warn("Not notarizing: Missing APPLE_ID_PASSWORD environment variable");
+    return;
+  }
   return notarize({
-    appBundleId: appId,
-    appPath: appPath,
-    appleId: process.env.APPLEID,
-    appleIdPassword: process.env.APPLEIDPASS,
+    appBundleId,
+    appPath,
+    appleId,
+    appleIdPassword,
   });
 };
diff --git a/package.json b/package.json
@@ -1,49 +1,32 @@
 {
   "name": "electron-updater-example",
-  "version": "0.7.2",
+  "version": "0.8.1",
   "main": "main.js",
   "description": "electron-updater example project",
   "author": "Matt Haggard",
   "scripts": {
-    "publish": "electron-builder -p always",
-    "publish-linux-docker": "./build/linuxInstallers.sh"
+    "publish": "electron-builder -p always"
   },
   "devDependencies": {
     "electron": "^14.0.1",
     "electron-builder": "^22.11.7",
-    "js-yaml": "^4.1.0"
+    "electron-notarize": "^1.1.1"
   },
   "dependencies": {
     "electron-log": "^4.4.1",
     "electron-updater": "^4.3.9"
   },
   "build": {
     "appId": "com.github.iffy.electronupdaterexample",
-    "productName": "Electron Updater Example",
-    "afterSign": "./build.notarize.js",
-    "directories": {
-      "output": "dist"
-    },
-    "files": [
-      "!.DS_Store"
-    ],
+    "afterSign": "./build/notarize.js",
     "mac": {
-      "category": "your.app.category.type",
-      "target": "default",
-      "type": "distribution",
-      "hardenedRuntime": true,
-      "gatekeeperAsses": false,
-      "entitlements": "./build/entitlements.mac.plist"
-    },
-    "dmg": {
-      "sign": false
+      "category": "your.app.category.type"
     },
     "win": {
       "target": "nsis"
     },
     "nsis": {
-      "oneClick": false,
-      "allowToChangeInstallationDirectory": true
+      "oneClick": false
     },
     "linux": {
       "category": "your.app.category.type",
