fix: electron-builder not generating "latest.yml" file

Closes #925

Author: develar

.idea/rc-producer.yml

@@ -14,6 +14,8 @@ language: c
 cache:
   directories:
     - node_modules
+    - packages/electron-builder/node_modules
+    - packages/electron-builder-util/node_modules
     - $HOME/.electron
     - /tmp/jest-electron-builder-tests
 

.travis.yml

@@ -51,7 +51,7 @@ export class GitHubProvider implements Provider<VersionInfo> {
   async getUpdateFile(versionInfo: UpdateInfo): Promise<FileInfo> {
     const basePath = this.getBasePath()
     // space is not supported on GitHub
-    const name = path.posix.basename(versionInfo.path).replace(/ /g, "-")
+    const name = versionInfo.githubArtifactName || path.posix.basename(versionInfo.path).replace(/ /g, "-")
     return {
       name: name,
       url: `https://github.com${basePath}/download/v${versionInfo.version}/${name}`,

packages/electron-auto-updater/src/GitHubProvider.ts

@@ -49,6 +49,7 @@ export interface VersionInfo {
 
 export interface UpdateInfo extends VersionInfo {
   readonly path: string
+  readonly githubArtifactName?: string | null
   readonly sha2: string
 }
 

packages/electron-builder-http/src/publishOptions.ts

@@ -291,13 +291,7 @@ function publishManager(packager: Packager, publishTasks: Array<BluebirdPromise<
             if (it == null) {
               return null
             }
-
-            if (event.file == null) {
-              return publishTasks.push(<BluebirdPromise<any>>it.uploadData(event.data!, event.artifactName!))
-            }
-            else {
-              return publishTasks.push(<BluebirdPromise<any>>it.upload(event.file!, event.artifactName))
-            }
+            return publishTasks.push(<BluebirdPromise<any>>it.upload(event.file, event.artifactName))
           })
       }
     }

packages/electron-builder/src/builder.ts

@@ -541,8 +541,7 @@ export interface RepositoryInfo {
 export interface ArtifactCreated {
   readonly packager: PlatformPackager<any>
 
-  readonly file?: string
-  readonly data?: Buffer
+  readonly file: string
 
   readonly artifactName?: string
 
@@ -586,6 +585,7 @@ export function getPublishConfigs(packager: PlatformPackager<any>, platformSpeci
 
   if (publishers == null) {
     publishers = packager.config.publish
+    // triple equals - if explicitly set to null
     if (publishers === null) {
       return null
     }

packages/electron-builder/src/platformPackager.ts

@@ -14,6 +14,7 @@ import { safeDump } from "js-yaml"
 import { createHash } from "crypto"
 import { Target, Arch } from "electron-builder-core"
 import sanitizeFileName from "sanitize-filename"
+import { unlinkIfExists } from "electron-builder-util/out/fs"
 
 const NSIS_VERSION = "3.0.4"
 //noinspection SpellCheckingInspection
@@ -42,14 +43,25 @@ export default class NsisTarget extends Target {
     }
   }
 
-  private computePublishConfigs(): Promise<Array<PublishConfiguration> | null> {
-    const publishConfigs = getPublishConfigs(this.packager, this.options)
-    if (publishConfigs != null && publishConfigs.length > 0) {
-      return BluebirdPromise.map(publishConfigs, it => getResolvedPublishConfig(this.packager.info, it, true))
+  private async computePublishConfigs(): Promise<Array<PublishConfiguration> | null> {
+    let publishConfigs = getPublishConfigs(this.packager, this.options)
+    if (publishConfigs == null) {
+      return null
     }
-    else {
-      return BluebirdPromise.resolve(null)
+
+    if (publishConfigs.length === 0) {
+      // https://github.com/electron-userland/electron-builder/issues/925#issuecomment-261732378
+      // default publish config is github, file should be generated regardless of publish state (user can test installer locally or manage the release process manually)
+      const repositoryInfo = await this.packager.getRepositoryInfo()
+      if (repositoryInfo != null && repositoryInfo.type === "github") {
+        publishConfigs = [{provider: "github"}]
+      }
+      else {
+        return null
+      }
     }
+
+    return await BluebirdPromise.map(publishConfigs, it => <Promise<PublishConfiguration>>getResolvedPublishConfig(this.packager.info, it, true))
   }
 
   build(appOutDir: string, arch: Arch) {
@@ -226,36 +238,36 @@ export default class NsisTarget extends Target {
     const publishConfigs = await this.publishConfigs
     const githubArtifactName = `${appInfo.name}-Setup-${version}.exe`
     if (publishConfigs != null) {
-      let sha2: string | null = null
       for (const publishConfig of publishConfigs) {
-        if (publishConfig.provider === "generic" || publishConfig.provider === "github") {
-          if (sha2 == null) {
-            sha2 = await sha256(installerPath)
-          }
+        if (!(publishConfig.provider === "generic" || publishConfig.provider === "github")) {
+          continue
+        }
 
-          const channel = (<GenericServerOptions>publishConfig).channel || "latest"
-          if (publishConfig.provider === "generic") {
-            await writeFile(path.join(this.outDir, `${channel}.yml`), safeDump(<UpdateInfo>{
-              version: version,
-              path: installerFilename,
-              sha2: sha2,
-            }))
-          }
-          else {
-            packager.info.eventEmitter.emit("artifactCreated", <ArtifactCreated>{
-              data: new Buffer(safeDump(<UpdateInfo>{
-                version: version,
-                path: githubArtifactName,
-                sha2: sha2,
-              })),
-              artifactName: `${channel}.yml`,
-              packager: packager,
-              publishConfig: publishConfig,
-            })
-          }
+        const sha2 = await sha256(installerPath)
+        const channel = (<GenericServerOptions>publishConfig).channel || "latest"
+        const updateInfoFile = path.join(this.outDir, `${channel}.yml`)
+        await writeFile(updateInfoFile, safeDump(<UpdateInfo>{
+          version: version,
+          githubArtifactName: githubArtifactName,
+          path: installerFilename,
+          sha2: sha2,
+        }))
+
+        const githubPublishConfig = publishConfigs.find(it => it.provider === "github")
+        if (githubPublishConfig != null) {
+          packager.info.eventEmitter.emit("artifactCreated", <ArtifactCreated>{
+            file: updateInfoFile,
+            packager: packager,
+            publishConfig: githubPublishConfig,
+          })
         }
+
+        break
       }
     }
+    else {
+      await unlinkIfExists(path.join(this.outDir, `latest.yml`))
+    }
 
     packager.dispatchArtifactCreated(installerPath, githubArtifactName)
   }

packages/electron-builder/src/targets/nsis.ts

@@ -78,10 +78,18 @@ export class WinPackager extends PlatformPackager<WinBuildOptions> {
         switch (name) {
           case "nsis":
             return require("./targets/nsis").default
+
           case "squirrel":
-            return require("electron-builder-squirrel-windows").default
+            try {
+              return require("electron-builder-squirrel-windows").default
+            }
+            catch (e) {
+              throw new Error(`Since electron-builder 11, module electron-builder-squirrel-windows must be installed in addition to build Squirrel.Windows: ${e.stack || e}`)
+            }
+
           case "appx":
             return require("./targets/appx").default
+
           default:
             return null
         }

packages/electron-builder/src/winPackager.ts

@@ -344,7 +344,8 @@ async function checkWindowsResult(packager: Packager, checkOptions: AssertPackOp
     }
   }
 
-  assertThat(getFileNames(artifacts)).containsAll(expectedFileNames)
+  // we test latest.yml separately, don't want to complicate general assert
+  assertThat(getFileNames(artifacts).filter(it => it !== "latest.yml")).containsAll(expectedFileNames)
 
   if (!squirrel) {
     return
@@ -356,7 +357,8 @@ async function checkWindowsResult(packager: Packager, checkOptions: AssertPackOp
   const unZipper = new DecompressZip(packageFile)
   const fileDescriptors = await unZipper.getFiles()
 
-  const files = pathSorter(fileDescriptors.map(it => it.path.replace(/\\/g, "/")).filter(it => (!it.startsWith("lib/net45/locales/") || it === "lib/net45/locales/en-US.pak") && !it.endsWith(".psmdcp")))
+  // we test app-update.yml separately, don't want to complicate general assert (yes, it is not good that we write app-update.yml for squirrel.windows if we build nsis and squirrel.windows in parallel, but as squirrel.windows is deprecated, it is ok)
+  const files = pathSorter(fileDescriptors.map(it => it.path.replace(/\\/g, "/")).filter(it => (!it.startsWith("lib/net45/locales/") || it === "lib/net45/locales/en-US.pak") && !it.endsWith(".psmdcp") && !it.endsWith("app-update.yml")))
 
   // console.log(JSON.stringify(files, null, 2))
   const expectedContents = checkOptions == null || checkOptions.expectedContents == null ? expectedWinContents : checkOptions.expectedContents