builder util runtime.Interface.GithubOptions

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

PublishConfiguration

Properties¶

channel?¶

readonly optional channel: null | string

The channel.

Default¶

latest

host?¶

readonly optional host: null | string

The host (including the port if need).

Default¶

github.com

owner?¶

readonly optional owner: null | string

The owner.

private?¶

readonly optional private: null | boolean

Whether to use private github auto-update provider if GH_TOKEN environment variable is defined. See Private GitHub Update Repo.

protocol?¶

readonly optional protocol: null | "https" | "http"

The protocol. GitHub Publisher supports only https.

Default¶

https

provider¶

readonly provider: "github"

The provider. Must be github.

Overrides¶

PublishConfiguration.provider

releaseType?¶

optional releaseType: null | "draft" | "prerelease" | "release"

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

readonly optional repo: null | string

The repository name. Detected automatically.

token?¶

readonly optional token: null | string

The access token to support auto-update from private github repositories. Never specify it in the configuration files. Only for setFeedURL.

vPrefixedTagName?¶

readonly optional vPrefixedTagName: boolean

Whether to use v-prefixed tag name.

Default¶

true