Skip to main content

GithubSource class

Retrieves available releases from a GitHub repository. Supports both github.com and GitHub Enterprise instances.

class GithubSource

Constructors

ConstructorSummary
constructorCreate a new GithubSource.

constructor(repoUrl, accessToken, prerelease)

constructor(repoUrl: string, accessToken?: string, prerelease?: boolean)

Create a new GithubSource.

Parameters

NameTypeDescription
repoUrlstringThe URL of the GitHub repository (e.g. "https://github.com/myuser/myrepo").
accessTokenstringOptional GitHub access token. Without one, requests are rate limited to 60/hr per IP. (optional)
prereleasebooleanIf true, pre-releases will also be searched/downloaded. (optional)

Properties

PropertySummary
accessToken
prerelease
repoUrl

accessToken

accessToken: string

readonly

prerelease

prerelease: boolean

readonly

repoUrl

repoUrl: string

readonly


Generated from velopack 1.2.110-ge826545