feat(deployment): Do not upload auto-update files for the second conf…

…igured provider Close #2697
electron-userland · Mar 18, 2018 · cec3069 · cec3069
1 parent 7a9d220
commit cec3069
Show file tree

Hide file tree

Showing 4 changed files with 75 additions and 2 deletions.
diff --git a/packages/builder-util-runtime/src/publishOptions.ts b/packages/builder-util-runtime/src/publishOptions.ts
@@ -15,6 +15,16 @@ export interface PublishConfiguration {
    * @private
    */
   readonly publisherName?: Array<string> | null
+
+  /**
+   * Whether to publish auto update info files.
+   *
+   * Auto update relies only on the first provider in the list (you can specify several publishers).
+   * Thus, probably, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.
+   *
+   * @default true
+   */
+  readonly publishAutoUpdate?: boolean
 }
 
 /**

diff --git a/packages/electron-builder-lib/src/publish/updateInfoBuilder.ts b/packages/electron-builder-lib/src/publish/updateInfoBuilder.ts
@@ -1,5 +1,5 @@
 import BluebirdPromise from "bluebird-lst"
-import { Arch, hashFile, safeStringifyJson, serializeToYaml } from "builder-util"
+import { Arch, hashFile, safeStringifyJson, serializeToYaml, log } from "builder-util"
 import { GenericServerOptions, GithubOptions, PublishConfiguration, UpdateInfo, WindowsUpdateInfo } from "builder-util-runtime"
 import { outputFile, outputJson, readFile } from "fs-extra-p"
 import { Lazy } from "lazy-val"
@@ -184,6 +184,15 @@ export async function writeUpdateInfoFiles(updateInfoFileTasks: Array<UpdateInfo
 
   const releaseDate = new Date().toISOString()
   await BluebirdPromise.map(updateChannelFileToInfo.values(), async task => {
+    const publishConfig = task.publishConfiguration
+    if (publishConfig.publishAutoUpdate === false) {
+      log.debug({
+        provider: publishConfig.provider,
+        reason: "publishAutoUpdate is set to false"
+      }, "auto update metadata file not published")
+      return
+    }
+
     task.info.releaseDate = releaseDate
     const fileContent = Buffer.from(serializeToYaml(task.info))
     await outputFile(task.file, fileContent)
@@ -193,7 +202,7 @@ export async function writeUpdateInfoFiles(updateInfoFileTasks: Array<UpdateInfo
       arch: null,
       packager: task.packager,
       target: null,
-      publishConfig: task.publishConfiguration,
+      publishConfig,
     })
   }, {concurrency: 4})
 }

diff --git a/test/out/__snapshots__/PublishManagerTest.js.snap b/test/out/__snapshots__/PublishManagerTest.js.snap
@@ -117,6 +117,39 @@ Object {
 }
 `;
 
+exports[`github and spaces (publishAutoUpdate) 1`] = `
+Object {
+  "linux": Array [
+    Object {
+      "arch": "x64",
+      "file": "TestApp-1.1.0-x86_64.AppImage",
+      "updateInfo": Object {
+        "blockMapSize": "@blockMapSize",
+        "sha512": "@sha512",
+        "size": "@size",
+      },
+    },
+    Object {
+      "file": "latest-linux.yml",
+      "fileContent": Object {
+        "files": Array [
+          Object {
+            "blockMapSize": "@blockMapSize",
+            "sha512": "@sha512",
+            "size": "@size",
+            "url": "TestApp-1.1.0-x86_64.AppImage",
+          },
+        ],
+        "path": "TestApp-1.1.0-x86_64.AppImage",
+        "releaseDate": "@releaseDate",
+        "sha512": "@sha512",
+        "version": "1.1.0",
+      },
+    },
+  ],
+}
+`;
+
 exports[`mac artifactName  1`] = `
 Object {
   "mac": Array [

diff --git a/test/src/PublishManagerTest.ts b/test/src/PublishManagerTest.ts
@@ -28,6 +28,27 @@ test.ifDevOrLinuxCi("generic, github and spaces", app({
   },
 }))
 
+test.ifDevOrLinuxCi("github and spaces (publishAutoUpdate)", app({
+  targets: Platform.LINUX.createTarget("AppImage"),
+  config: {
+    mac: {
+      electronUpdaterCompatibility: ">=2.16",
+    },
+    publish: [
+      {
+        provider: "github",
+        repo: "foo/foo"
+      },
+      {
+        provider: "spaces",
+        name: "mySpaceName",
+        region: "nyc3",
+        publishAutoUpdate: false
+      },
+    ]
+  },
+}))
+
 test.ifDevOrLinuxCi.ifAll("mac artifactName ", app({
   targets: Platform.MAC.createTarget("zip"),
   config: {