AzurePipelinesReportPrinter Class

Summary

The TF Build/Azure Pipelines report printer.
Assembly
Cake.AzurePipelines.Module.dll
Namespace
Cake.AzurePipelines.Module
Interfaces
  • ICakeReportPrinter
Base Types
graph BT Type-->Base0["CakeReportPrinterBase"] click Base0 "/api/Cake.Module.Shared/CakeReportPrinterBase" Base0-->Base1["Object"] Type-.->Interface0["ICakeReportPrinter"] Type["AzurePipelinesReportPrinter"] class Type type-node

Syntax

public class AzurePipelinesReportPrinter : CakeReportPrinterBase, ICakeReportPrinter

Constructors

Name Summary
AzurePipelinesReportPrinter(IConsole, ICakeContext) Initializes a new instance of the AzurePipelinesReportPrinter class.

Fields

Name Constant Value Summary
_console
Gets the IConsole.
Inherited from CakeReportPrinterBase
_context
Gets the ICakeContext.
Inherited from CakeReportPrinterBase

Methods

Name Value Summary
FormatDuration(CakeReportEntry) string
Returns the formatted time it took to process one CakeReportEntry.
Inherited from CakeReportPrinterBase
static
FormatTime(TimeSpan) string
Formats a TimeSpan.
Inherited from CakeReportPrinterBase
static
GetItemForegroundColor(CakeReportEntry) ConsoleColor
Calculates the foreground color required to write out one CakeReportEntry.
Inherited from CakeReportPrinterBase
static
GetTotalTime(IEnumerable<CakeReportEntry>) TimeSpan
Calculates the total time it took to process all CakeReportEntry elements.
Inherited from CakeReportPrinterBase
static
ShouldWriteTask(CakeReportEntry) bool
Check if the CakeReportEntry should be written.
Inherited from CakeReportPrinterBase
Write(CakeReport) void
Writes the specified report to a target.
WriteToConsole(CakeReport) void
Writes the report to the IConsole.
Inherited from CakeReportPrinterBase

Extension Methods

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