Class PleOpsBuildContext

Namespace

Cake.Frosting.PleOps.Recipe

Assembly

Cake.Frosting.PleOps.Recipe.dll

Build context information to share across tasks.

public class PleOpsBuildContext : FrostingContext, IFrostingContext, ICakeContext

Inheritance

object

CakeContextAdapter

FrostingContext

PleOpsBuildContext

Implements

IFrostingContext

ICakeContext

Inherited Members

CakeContextAdapter.FileSystem

CakeContextAdapter.Environment

CakeContextAdapter.Globber

CakeContextAdapter.Log

CakeContextAdapter.Arguments

CakeContextAdapter.ProcessRunner

CakeContextAdapter.Registry

CakeContextAdapter.Tools

CakeContextAdapter.Data

CakeContextAdapter.Configuration

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PleOpsBuildContext(ICakeContext)

Initializes a new instance of the PleOpsBuildContext class.

public PleOpsBuildContext(ICakeContext context)

Parameters

context ICakeContext

The context to pass to the base class.

Properties

ArtifactsPath

Gets or sets the path to directory to write the artifacts.

public string ArtifactsPath { get; set; }

Property Value

string

BuildKind

Gets or sets the kind of build to perform.

public BuildKind BuildKind { get; set; }

Property Value

BuildKind

Remarks

GitVersion can set it.

ChangelogFile

Gets or sets the path to the full changelog file.

public string ChangelogFile { get; set; }

Property Value

string

ChangelogNextFile

Gets or sets the path to the next release changelog file.

public string ChangelogNextFile { get; set; }

Property Value

string

DeliveriesContext

Gets or sets the build context for the project's deliveries.

public DeliveriesContext DeliveriesContext { get; set; }

Property Value

DeliveriesContext

DocFxContext

Gets or sets the build context for DocFX projects.

public DocFxBuildContext DocFxContext { get; set; }

Property Value

DocFxBuildContext

DotNetContext

Gets or sets the build context for .NET projects.

public DotNetBuildContext DotNetContext { get; set; }

Property Value

DotNetBuildContext

GitHubContext

Gets or sets the build context for GitHub interactions.

public GitHubBuildContext GitHubContext { get; set; }

Property Value

GitHubBuildContext

IsIncrementalBuild

Gets or sets a value indicating whether to do an incremental build and skip cleaning existing artifacts and dependencies.

public bool IsIncrementalBuild { get; set; }

Property Value

bool

RepositoryRootPath

Gets or sets the path to the project repository root.

public string RepositoryRootPath { get; set; }

Property Value

string

Remarks

Automatically obtained via command-line Git.

TemporaryPath

Gets or sets a path to the build temporary directory.

public string TemporaryPath { get; set; }

Property Value

string

Version

Gets or sets the build version.

public string Version { get; set; }

Property Value

string

Remarks

GitVersion can set it.

WarningsAsErrors

Gets or sets a value indicating whether to fail on warnings reported.

public bool WarningsAsErrors { get; set; }

Property Value

bool

Methods

Print()

Log the non-sensitive information of the build context.

public void Print()

ReadArguments()

Initialize the build context with command-line arguments if present.

public virtual void ReadArguments()