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

• PublishConfiguration

Properties

channel?

readonly optional channel?: string | null

The channel.

Default

latest

---

host?

readonly optional host?: string | null

The host (including the port if need).

Default

github.com

---

owner?

readonly optional owner?: string | null

The owner.

---

private?

readonly optional private?: boolean | null

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

---

protocol?

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

The protocol. GitHub Publisher supports only https.

Default

https

---

provider

readonly provider: "github"

The provider. Must be github.

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

---

releaseType?

optional releaseType?: "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?

readonly optional repo?: string | null

The repository name. Detected automatically.

---

requestHeaders?

readonly optional requestHeaders?: OutgoingHttpHeaders

Any custom request headers

Inherited from

PublishConfiguration.requestHeaders

---

tagNamePrefix?

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

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 github repositories. Never specify it in the configuration files. Only for setFeedURL.