GiteaSource class
Namespace: Velopack.Sources
Retrieves available releases from a Gitea repository.
public class GiteaSource : GitBase<GiteaRelease>, IUpdateSource
Inherits: GitBase<GiteaRelease>
Implements: IUpdateSource
Constructors
| Constructor | Summary |
|---|---|
GiteaSource | Retrieves available releases from a Gitea repository. |
GiteaSource(repoUrl, accessToken, prerelease, downloader)
public GiteaSource(string repoUrl, string? accessToken, bool prerelease, IFileDownloader? downloader = null)
Retrieves available releases from a Gitea repository.
Parameters
| Name | Type | Description |
|---|---|---|
repoUrl | string | The URL of the Gitea repository to download releases from (e.g. https://Gitea.com/myuser/myrepo) |
accessToken | string | The Gitea access token to use with the request to download releases. If left empty, the Gitea rate limit for unauthenticated requests allows for up to 60 requests per hour, limited by IP address. |
prerelease | bool | If true, pre-releases will be also be searched / downloaded. If false, only stable releases will be considered. |
downloader | IFileDownloader | The file downloader used to perform HTTP requests. |
Properties
| Property | Summary |
|---|---|
Authorization |
Authorization
protected override (string Name, string Value)? Authorization { get; }
Methods
| Method | Summary |
|---|---|
GetReleases | Retrieves a list of GithubRelease from the current repository. |
GetAssetUrlFromName | Given a GithubRelease and an asset filename (eg. 'RELEASES') this |
GetApiBaseUrl | Given a repository URL (e.g. https://Gitea.com/myuser/myrepo) this function |
GetReleases(includePrereleases)
protected override Task<GiteaRelease[]> GetReleases(bool includePrereleases)
Retrieves a list of GithubRelease from the current repository.
Parameters
| Name | Type | Description |
|---|---|---|
includePrereleases | bool |
Returns Task<GiteaRelease[]>
GetAssetUrlFromName(release, assetName)
protected override string GetAssetUrlFromName(GiteaRelease release, string assetName)
Given a GithubRelease and an asset filename (eg. 'RELEASES') this
function will return either BrowserDownloadUrl or
Url, depending whether an access token is available
or not. Throws if the specified release has no matching assets.
Parameters
| Name | Type | Description |
|---|---|---|
release | GiteaRelease | |
assetName | string |
Returns string
GetApiBaseUrl(repoUrl)
protected virtual Uri GetApiBaseUrl(Uri repoUrl)
Given a repository URL (e.g. https://Gitea.com/myuser/myrepo) this function returns the API base for performing requests. (eg. "https://api.Gitea.com/" or http://internal.Gitea.server.local/api/v1) or http://localhost:3000/api/v1
Parameters
| Name | Type | Description |
|---|---|---|
repoUrl | Uri |
Returns Uri
Generated from Velopack 1.1.1