Skip to main content

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?​

readonly optional channel?: string | null

The channel.

Default​

latest

host?​

readonly optional host?: string | null

The GitLab host (including the port if need).

Default​

gitlab.com

projectId?​

readonly optional projectId?: string | number | null

The GitLab project ID or path (e.g., "12345678" or "namespace/project").

provider​

readonly provider: "gitlab"

The provider. Must be gitlab.

Overrides​

PublishConfiguration.provider

publishAutoUpdate?​

readonly optional publishAutoUpdate?: 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?​

readonly optional requestHeaders?: OutgoingHttpHeaders

Any custom request headers

Inherited from​

PublishConfiguration.requestHeaders

timeout?​

readonly optional timeout?: number | null

Request timeout in milliseconds. (Default is 2 minutes; O is ignored)

Default​

120000

Inherited from​

PublishConfiguration.timeout

token?​

readonly optional token?: string | null

The access token to support auto-update from private GitLab repositories. Never specify it in the configuration files.

uploadTarget?​

readonly optional uploadTarget?: "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?​

readonly optional vPrefixedTagName?: boolean

Whether to use v-prefixed tag name.

Default​

true