Interface: GitlabOptions
GitLab options.
GitLab personal access token is required for private repositories. You can generate one by going to your GitLab profile settings.
Define GITLAB_TOKEN environment variable.
Extends
Properties
channel?
readonlyoptionalchannel?:string|null
The channel.
Default
latest
host?
readonlyoptionalhost?:string|null
The GitLab host (including the port if need).
Default
gitlab.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
projectId?
readonlyoptionalprojectId?:string|number|null
The GitLab project ID or path (e.g., "12345678" or "namespace/project").
provider
readonlyprovider:"gitlab"
The provider. Must be gitlab.
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
requestHeaders?
readonlyoptionalrequestHeaders?:OutgoingHttpHeaders
Any custom request headers
Inherited from
PublishConfiguration.requestHeaders
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 GitLab repositories. Never specify it in the configuration files.
uploadTarget?
readonlyoptionaluploadTarget?:"project_upload"|"generic_package"|null
Upload target method. Can be "project_upload" for GitLab project uploads or "generic_package" for GitLab generic packages.
Default
"project_upload"
vPrefixedTagName?
readonlyoptionalvPrefixedTagName?:boolean
Whether to use v-prefixed tag name.
Default
true