Skip to content

Commit 48c5953

Browse files
authored
fix(docs): update autoupdate docs noting that channels work with Github (#8227)
1 parent 77f9774 commit 48c5953

File tree

3 files changed

+16
-3
lines changed

3 files changed

+16
-3
lines changed

.changeset/selfish-turtles-fold.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
"app-builder-lib": patch
3+
"dmg-builder": patch
4+
"electron-builder": patch
5+
"electron-builder-squirrel-windows": patch
6+
"electron-forge-maker-appimage": patch
7+
"electron-forge-maker-nsis": patch
8+
"electron-forge-maker-nsis-web": patch
9+
"electron-forge-maker-snap": patch
10+
"electron-updater": patch
11+
---
12+
13+
fix(docs): update autoupdate docs noting that channels work with Github

docs/api/electron-builder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3397,7 +3397,7 @@ return await getCertInfo(cscFile, cscInfo.password || “”)
33973397
<p><code id="AppUpdater-currentVersion">currentVersion</code> SemVer - The current application version.</p>
33983398
</li>
33993399
<li>
3400-
<p><strong><code id="AppUpdater-channel">channel</code></strong> String | “undefined” - Get the update channel. Not applicable for GitHub. Doesn’t return <code>channel</code> from the update configuration, only if was previously set.</p>
3400+
<p><strong><code id="AppUpdater-channel">channel</code></strong> String | “undefined” - Get the update channel. Doesn’t return <code>channel</code> from the update configuration, only if was previously set.</p>
34013401
</li>
34023402
<li>
34033403
<p><strong><code id="AppUpdater-requestHeaders">requestHeaders</code></strong> [key: string]: string | “undefined” - The request headers.</p>

packages/electron-updater/src/AppUpdater.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,14 +123,14 @@ export abstract class AppUpdater extends (EventEmitter as new () => TypedEmitter
123123
protected downloadedUpdateHelper: DownloadedUpdateHelper | null = null
124124

125125
/**
126-
* Get the update channel. Not applicable for GitHub. Doesn't return `channel` from the update configuration, only if was previously set.
126+
* Get the update channel. Doesn't return `channel` from the update configuration, only if was previously set.
127127
*/
128128
get channel(): string | null {
129129
return this._channel
130130
}
131131

132132
/**
133-
* Set the update channel. Not applicable for GitHub. Overrides `channel` in the update configuration.
133+
* Set the update channel. Overrides `channel` in the update configuration.
134134
*
135135
* `allowDowngrade` will be automatically set to `true`. If this behavior is not suitable for you, simple set `allowDowngrade` explicitly after.
136136
*/

0 commit comments

Comments
 (0)