docs: state detectUpdateChannel ignored when publishing to github (#8928)

Author: rotu

.changeset/slimy-ligers-dance.md

@@ -0,0 +1,5 @@
+---
+"app-builder-lib": patch
+---
+
+chore(docs): Document that detectUpdateChannel doesn't work when publishing to github

packages/app-builder-lib/scheme.json

@@ -1756,7 +1756,7 @@
         },
         "detectUpdateChannel": {
           "default": true,
-          "description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.",
+          "description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.\nThis does *not* apply to github publishing, which will [never auto-detect the update channel](https://github.com/electron-userland/electron-builder/issues/8589).",
           "type": "boolean"
         },
         "disableDefaultIgnoredFiles": {
@@ -2437,7 +2437,7 @@
         },
         "detectUpdateChannel": {
           "default": true,
-          "description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.",
+          "description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.\nThis does *not* apply to github publishing, which will [never auto-detect the update channel](https://github.com/electron-userland/electron-builder/issues/8589).",
           "type": "boolean"
         },
         "disableDefaultIgnoredFiles": {
@@ -3069,7 +3069,7 @@
         },
         "detectUpdateChannel": {
           "default": true,
-          "description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.",
+          "description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.\nThis does *not* apply to github publishing, which will [never auto-detect the update channel](https://github.com/electron-userland/electron-builder/issues/8589).",
           "type": "boolean"
         },
         "disableDefaultIgnoredFiles": {
@@ -6274,7 +6274,7 @@
         },
         "detectUpdateChannel": {
           "default": true,
-          "description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.",
+          "description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.\nThis does *not* apply to github publishing, which will [never auto-detect the update channel](https://github.com/electron-userland/electron-builder/issues/8589).",
           "type": "boolean"
         },
         "disableDefaultIgnoredFiles": {
@@ -6960,7 +6960,7 @@
     },
     "detectUpdateChannel": {
       "default": true,
-      "description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.",
+      "description": "Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.\nThis does *not* apply to github publishing, which will [never auto-detect the update channel](https://github.com/electron-userland/electron-builder/issues/8589).",
       "type": "boolean"
     },
     "directories": {

packages/app-builder-lib/src/options/PlatformSpecificBuildOptions.ts

@@ -170,6 +170,7 @@ export interface PlatformSpecificBuildOptions extends TargetSpecificOptions, Fil
 
   /**
    * Whether to infer update channel from application version pre-release components. e.g. if version `0.12.1-alpha.1`, channel will be set to `alpha`. Otherwise to `latest`.
+   * This does *not* apply to github publishing, which will [never auto-detect the update channel](https://github.com/electron-userland/electron-builder/issues/8589).
    * @default true
    */
   readonly detectUpdateChannel?: boolean