AzurePipelinesCommands Class

Summary

Responsible for issuing Azure Pipelines agent commands (see ).
Namespace
Cake.Common.Build.AzurePipelines
Interfaces
Base Types
  • object
graph BT Type-->Base0["object"] Type-.->Interface0["IAzurePipelinesCommands"] click Interface0 "/api/Cake.Common.Build.AzurePipelines/IAzurePipelinesCommands" Type["AzurePipelinesCommands"] class Type type-node

Syntax

public sealed class AzurePipelinesCommands : IAzurePipelinesCommands

Constructors

Name Summary
AzurePipelinesCommands(ICakeEnvironment, IBuildSystemServiceMessageWriter) Initializes a new instance of the AzurePipelinesCommands class.

Methods

Name Value Summary
AddBuildTag(string) void
Add a tag for current build.
BeginGroup(string) void
Begin a collapsible group.
CompleteCurrentTask() void
Finish timeline record for current task and set task result to succeeded.
CompleteCurrentTask(AzurePipelinesTaskResult) void
Finish timeline record for current task and set task result.
CreateNewRecord(string, string, int, AzurePipelinesRecordData) Guid
Create detail timeline record.
CreateNewRecord(string, string, int) Guid
Create detail timeline record.
EndGroup() void
End a collapsible group.
LinkArtifact(string, AzurePipelinesArtifactType, string) void
Create an artifact link, such as a file or folder path or a version control path.
PublishCodeCoverage(AzurePipelinesPublishCodeCoverageData) void
Publishes and uploads code coverage results.
PublishCodeCoverage(FilePath, Action<AzurePipelinesPublishCodeCoverageData>) void
Publishes and uploads code coverage results.
PublishCodeCoverage(FilePath, AzurePipelinesPublishCodeCoverageData) void
Publishes and uploads code coverage results.
PublishTestResults(AzurePipelinesPublishTestResultsData) void
Publishes and uploads tests results.
Section(string) void
Log section.
SetOutputVariable(string, string) void
Sets a output variable in the variable service of the task context.
SetProgress(int, string) void
Set progress and current operation for current task.
SetSecretVariable(string, string) void
Sets a secret variable in the variable service of the task context.
SetVariable(string, string) void
Sets a variable in the variable service of the task context.
UpdateBuildNumber(string) void
Update build number for current build.
UpdateRecord(Guid, AzurePipelinesRecordData) void
Update an existing detail timeline record.
UploadArtifact(string, FilePath, string) void
Upload local file into a file container folder, and create an artifact.
UploadArtifact(string, FilePath) void
Upload local file into a file container folder.
UploadArtifactDirectory(DirectoryPath, string) void
Upload local directory as a container folder, and create an artifact with the specified name.
UploadArtifactDirectory(DirectoryPath) void
Upload local directory as a container folder, and create an artifact.
UploadBuildLogFile(FilePath) void
Upload additional log to build container's logs/tool folder.
UploadTaskLogFile(FilePath) void
Upload file as additional log information to the current timeline record.
UploadTaskSummary(FilePath) void
Upload and attach summary markdown to current timeline record.
WriteError(string, AzurePipelinesMessageData) void
Log an error with detailed data to timeline record of current task.
WriteError(string) void
Log an error to timeline record of current task.
WriteWarning(string, AzurePipelinesMessageData) void
Log a warning issue with detailed data to timeline record of current task.
WriteWarning(string) void
Log a warning issue to timeline record of current task.

Extension Methods

Name Value Summary
Dump<AzurePipelinesCommands>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
Group(string) IDisposable
Groups Azure Pipelines output.
IsIn<AzurePipelinesCommands>(AzurePipelinesCommands[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<AzurePipelinesCommands>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<AzurePipelinesCommands>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<AzurePipelinesCommands>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<AzurePipelinesCommands>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
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