GitLabAliases Class

Summary

Provides aliases for interacting with a GitLab Server
Assembly
Cake.GitLab.dll
Namespace
Cake.GitLab
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["GitLabAliases"] class Type type-node

Syntax

public static class GitLabAliases

Attributes

Type Description
CakeAliasCategoryAttribute
CakeNamespaceImportAttribute

Methods

Name Value Summary
GitLabGetPipelineAsync(ICakeContext, ProjectConnection, long) Task<Pipeline>
Gets data about a GitLab CI pipeline
static
GitLabGetPipelineAsync(ICakeContext, ProjectIdentity, string, long) Task<Pipeline>
Gets data about a GitLab CI pipeline
static
GitLabGetPipelineAsync(ICakeContext, ServerConnection, ProjectId, long) Task<Pipeline>
Gets data about a GitLab CI pipeline
static
GitLabGetPipelineAsync(ICakeContext, ServerIdentity, string, ProjectId, long) Task<Pipeline>
Gets data about a GitLab CI pipeline
static
GitLabGetPipelineAsync(ICakeContext, string, string, ProjectId, long) Task<Pipeline>
Gets data about a GitLab CI pipeline
static
GitLabRepositoryCreateTagAsync(ICakeContext, ProjectConnection, string, string) Task<Tag>
Creates a new tag in the project repository
static
GitLabRepositoryCreateTagAsync(ICakeContext, ProjectIdentity, string, string, string) Task<Tag>
Creates a new tag in the project repository
static
GitLabRepositoryCreateTagAsync(ICakeContext, ServerConnection, ProjectId, string, string) Task<Tag>
Creates a new tag in the project repository
static
GitLabRepositoryCreateTagAsync(ICakeContext, ServerIdentity, string, ProjectId, string, string) Task<Tag>
Creates a new tag in the project repository
static
GitLabRepositoryCreateTagAsync(ICakeContext, string, string, ProjectId, string, string) Task<Tag>
Creates a new tag in the project repository
static
GitLabRepositoryDownloadFileAsync(ICakeContext, ProjectConnection, string, string, FilePath) Task
Downloads a file from a GitLab-hosted repository
static
GitLabRepositoryDownloadFileAsync(ICakeContext, ProjectIdentity, string, string, string, FilePath) Task
Downloads a file from a GitLab-hosted repository
static
GitLabRepositoryDownloadFileAsync(ICakeContext, ServerConnection, ProjectId, string, string, FilePath) Task
Downloads a file from a GitLab-hosted repository
static
GitLabRepositoryDownloadFileAsync(ICakeContext, ServerIdentity, string, ProjectId, string, string, FilePath) Task
Downloads a file from a GitLab-hosted repository
static
GitLabRepositoryDownloadFileAsync(ICakeContext, string, string, ProjectId, string, string, FilePath) Task
Downloads a file from a GitLab-hosted repository
static
GitLabRepositoryGetBranchesAsync(ICakeContext, ProjectConnection) Task<IReadOnlyCollection<Branch>>
Lists all of a project's branches
static
GitLabRepositoryGetBranchesAsync(ICakeContext, ProjectIdentity, string) Task<IReadOnlyCollection<Branch>>
Lists all of a project's branches
static
GitLabRepositoryGetBranchesAsync(ICakeContext, ServerConnection, ProjectId) Task<IReadOnlyCollection<Branch>>
Lists all of a project's branches
static
GitLabRepositoryGetBranchesAsync(ICakeContext, ServerIdentity, string, ProjectId) Task<IReadOnlyCollection<Branch>>
Lists all of a project's branches
static
GitLabRepositoryGetBranchesAsync(ICakeContext, string, string, ProjectId) Task<IReadOnlyCollection<Branch>>
Lists all of a project's branches
static
GitLabSetPipelineNameAsync(ICakeContext, ProjectConnection, long, string) Task
Updates the name of the specified pipeline
static
GitLabSetPipelineNameAsync(ICakeContext, ProjectIdentity, string, long, string) Task
Updates the name of the specified pipeline
static
GitLabSetPipelineNameAsync(ICakeContext, ServerConnection, ProjectId, long, string) Task
Updates the name of the specified pipeline
static
GitLabSetPipelineNameAsync(ICakeContext, ServerIdentity, string, ProjectId, long, string) Task
Updates the name of the specified pipeline
static
GitLabSetPipelineNameAsync(ICakeContext, string, string, ProjectId, long, string) Task
Updates the name of the specified pipeline
static
GitLabTryGetCurrentProjectIdentity(ICakeContext) ProjectIdentity
Attempts to determine the ProjectIdentity from environment variables.
static
GitLabTryGetCurrentServerIdentity(ICakeContext) ServerIdentity
Attempts to determine the ServerIdentity from environment variables.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin