Interface: GithubOptions
GitHub options.
GitHub personal access token is required. You can generate by going to https://github.com/settings/tokens/new. The access token should have the repo scope/permission.
Define GH_TOKEN environment variable.
Extends
Properties
channel?
readonlyoptionalchannel?:string|null
The channel.
Default
latest
host?
readonlyoptionalhost?:string|null
The host (including the port if need).
Default
github.com
maxUpdateInfoSize?
readonlyoptionalmaxUpdateInfoSize?:number|null
The largest channel file (latest*.yml) electron-updater reads, in bytes: it is read into memory and parsed before anything
verifies it. A larger one fails the update check with ERR_UPDATER_RESPONSE_TOO_LARGE. Release feeds and provider API responses
(release listings and lookups) are not limited. Written into app-update.yml, so installed apps use it; autoUpdater.maxUpdateInfoSize
overrides it at runtime. A positive integer, or 0 for no limit.
Default
10485760
Inherited from
PublishConfiguration.maxUpdateInfoSize
owner?
readonlyoptionalowner?:string|null
The owner.
private?
readonlyoptionalprivate?:boolean|null
Whether to use private github auto-update provider if GH_TOKEN environment variable is defined. See Private GitHub Update Repo.
protocol?
readonlyoptionalprotocol?:"https"|"http"|null
The protocol. GitHub Publisher supports only https. electron-updater rejects an http feed to a host that is not loopback unless the app sets autoUpdater.allowInsecureFeed (meant for dev runs: autoUpdater.allowInsecureFeed = !app.isPackaged).
Default
https
provider
readonlyprovider:"github"
The provider. Must be github.
Overrides
publishAutoUpdate?
readonlyoptionalpublishAutoUpdate?:boolean
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, theres no need to upload the metadata files for the other configured providers. But by default will be uploaded. A provider with falsenever becomes the feed embedded inapp-update.yml` while a later provider receives the metadata:
the first provider that does is embedded instead.
Default
true
Inherited from
PublishConfiguration.publishAutoUpdate
releaseType?
optionalreleaseType?:"draft"|"prerelease"|"release"|null
The type of release. By default draft release will be created.
Also you can set release type using environment variable. If EP_DRAFTis set to true — draft, if EP_PRE_RELEASEis set to true — prerelease.
Default
draft
repo?
readonlyoptionalrepo?:string|null
The repository name. Detected automatically.
requestHeaders?
readonlyoptionalrequestHeaders?:OutgoingHttpHeaders
Any custom request headers
Inherited from
PublishConfiguration.requestHeaders
tagNamePrefix?
readonlyoptionaltagNamePrefix?:string
If defined, sets the prefix of the tag name that comes before the semver number. e.g. "v" in "v1.2.3" or "test" of "test1.2.3".
Default
"v"
timeout?
readonlyoptionaltimeout?:number|null
Request timeout in milliseconds. (Default is 2 minutes; O is ignored)
Default
120000
Inherited from
token?
readonlyoptionaltoken?:string|null
The access token to support auto-update from private github repositories. Never specify it in the configuration files. Only for setFeedURL.