Class RemoteRepoTagApi

Implements friendly GitHub repository tag related APIs.

Inheritance

object

RemoteRepoTagApi

Namespace: Neon.GitHub

Assembly: Neon.GitHub.dll

Syntax

public class RemoteRepoTagApi

Methods

FindAsync(string)

Searches for a specific GitHub origin repository tag.

Declaration

public Task<RepositoryTag> FindAsync(string tagName)

Parameters

Type	Name	Description
string	tagName	Specifies the origin repository tag name.

Returns

Type	Description
Task<RepositoryTag>	The requested Octokit.RepositoryTag or null when the tag doesn't exist.

Exceptions

Type	Condition
ObjectDisposedException	Thrown when the GitHubRepo has been disposed.

GetAllAsync()

Returns all tags from the GitHub origin repository.

Declaration

public Task<IReadOnlyList<RepositoryTag>> GetAllAsync()

Returns

Type	Description
Task<IReadOnlyList<RepositoryTag>>	The list of tags.

Exceptions

Type	Condition
ObjectDisposedException	Thrown when the GitHubRepo has been disposed.

RemoveAsync(string)

Removes an origin repository tag, if it exists.

Declaration

public Task<bool> RemoveAsync(string tagName)

Parameters

Type	Name	Description
string	tagName	Specifies the origin repository tag name.

Returns

Type	Description
Task<bool>	true if the tag existed and was removed, false otherwise.

Exceptions

Type	Condition
ObjectDisposedException	Thrown when the GitHubRepo has been disposed.