ContinuaCIProvider Class

Summary

Responsible for communicating with Continua CI.
Namespace
Cake.Common.Build.ContinuaCI
Interfaces
Base Types
  • object
graph BT Type-->Base0["object"] Type-.->Interface0["IContinuaCIProvider"] click Interface0 "/api/Cake.Common.Build.ContinuaCI/IContinuaCIProvider" Type["ContinuaCIProvider"] class Type type-node

Syntax

public sealed class ContinuaCIProvider : IContinuaCIProvider

Constructors

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

Properties

Name Value Summary
Environment ContinuaCIEnvironmentInfo
Gets the Continua CI environment.
IsRunningOnContinuaCI bool
Gets a value indicating whether the current build is running on Continua CI.

Methods

Name Value Summary
SetBuildStatus(string) void
Set a Continua CI build status message, which is shown on the build details page when a build is running.
SetBuildVersion(string) void
Set a Continua CI build version.
SetVariable(string, string, bool) void
Set a Continua CI build variable.
WriteEndBlock(string) void
Write the end of a message block to the Continua CI build log.
WriteMessage(string, ContinuaCIMessageType) void
Write a status message to the Continua CI build log.
WriteStartGroup(string) void
Write the start of a message group to the Continua CI build log.

Extension Methods

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