builder util runtime.Interface.GitlabOptions

Electron-Builder / builder-util-runtime / 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

• PublishConfiguration

Properties

channel?

readonly optional channel: null | string

The channel.

Default

latest

---

host?

readonly optional host: null | string

The GitLab host (including the port if need).

Default

gitlab.com

---

projectId?

readonly optional projectId: null | string | number

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, there`s no need to upload the metadata files for the other configured providers. But by default will be uploaded.

Default

true

Inherited from

PublishConfiguration.publishAutoUpdate

---

requestHeaders?

readonly optional requestHeaders: OutgoingHttpHeaders

Any custom request headers

Inherited from

PublishConfiguration.requestHeaders

---

timeout?

readonly optional timeout: null | number

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

Default

120000

Inherited from

PublishConfiguration.timeout

---

token?

readonly optional token: null | string

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

---

uploadTarget?

readonly optional uploadTarget: null | "project_upload" | "generic_package"

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