Class BaseBuild

The base Nuke build class.

Inheritance

object

NukeBuild

BaseBuild

Implements

IHasConfiguration

IHasPlatform

IHasTargetFramework

ILint

IPack

IPublish

IReportCoverage

ITest

ICompile

IHasGitVersion

IHasArtifacts

IUpdatePackages

IListOutdatedPackages

IRestore

INukeBuild

IHasSolution

Inherited Members

NukeBuild.Execute<T>(params Expression<Func<T, Target>>[])

NukeBuild.ReportSummary(Configure<Dictionary<string, string>>)

NukeBuild.OnBuildCreated()

NukeBuild.OnBuildInitialized()

NukeBuild.OnBuildFinished()

NukeBuild.OnTargetRunning(string)

NukeBuild.OnTargetSkipped(string)

NukeBuild.OnTargetSucceeded(string)

NukeBuild.OnTargetFailed(string)

NukeBuild.ExecutionPlan

NukeBuild.InvokedTargets

NukeBuild.SkippedTargets

NukeBuild.ScheduledTargets

NukeBuild.RunningTargets

NukeBuild.AbortedTargets

NukeBuild.FailedTargets

NukeBuild.SucceededTargets

NukeBuild.FinishedTargets

NukeBuild.Plan

NukeBuild.Help

NukeBuild.NoLogo

NukeBuild.Continue

NukeBuild.Partition

NukeBuild.NuGetPackagesConfigFile

NukeBuild.NuGetAssetsConfigFile

NukeBuild.NpmPackageJsonFile

NukeBuild.EmbeddedPackagesDirectory

NukeBuild.IsSucceeding

NukeBuild.IsFailing

NukeBuild.IsFinished

NukeBuild.ExitCode

NukeBuild.RootDirectory

NukeBuild.TemporaryDirectory

NukeBuild.BuildAssemblyFile

NukeBuild.BuildAssemblyDirectory

NukeBuild.BuildProjectDirectory

NukeBuild.BuildProjectFile

NukeBuild.Verbosity

NukeBuild.Host

NukeBuild.LoadedLocalProfiles

NukeBuild.IsLocalBuild

NukeBuild.IsServerBuild

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Microsoft.XboxStudios.NukeExt

Assembly: NukeExt.dll

Syntax

[ShutdownDotNetAfterServerBuild]
public abstract class BaseBuild : NukeBuild, IHasConfiguration, IHasPlatform, IHasTargetFramework, ILint, IPack, IPublish, IReportCoverage, ITest, ICompile, IHasGitVersion, IHasArtifacts, IUpdatePackages, IListOutdatedPackages, IRestore, INukeBuild, IHasSolution

Constructors

BaseBuild(bool)

Initializes a new instance of the BaseBuild class.

Declaration

public BaseBuild(bool disableConfigurationCheck = false)

Parameters

Type	Name	Description
bool	disableConfigurationCheck	Whether to validate generated configuration files.

Properties

AddFeatureBranchNameToVersion

Gets or sets a value indicating whether to add the feature branch name to NuGet package versions.

Declaration

[Parameter("Whether to add the feature branch name to NuGet package versions")]
public bool AddFeatureBranchNameToVersion { get; set; }

Property Value

Type	Description
bool

AddGitVersioning

Gets or sets a value indicating whether to add Nerdbank Git versioning metadata.

Declaration

[Parameter("Whether to add Nerdbank Git versioning metadata")]
public bool AddGitVersioning { get; set; }

Property Value

Type	Description
bool

ArtifactsDirectory

Gets or sets the output folder for artifacts.

Declaration

[Parameter("Output folder for artifacts")]
public AbsolutePath? ArtifactsDirectory { get; set; }

Property Value

Type	Description
AbsolutePath

CD

Gets the target to run continuous deployment.

Declaration

protected Target CD { get; }

Property Value

Type	Description
Target

CI

Gets the target to run continuous integration.

Declaration

protected Target CI { get; }

Property Value

Type	Description
Target

CentralPackagesFile

Gets or sets the central NuGet packages file location.

Declaration

[Parameter("The central NuGet packages file location")]
public AbsolutePath? CentralPackagesFile { get; set; }

Property Value

Type	Description
AbsolutePath

CodeCoverageDirectory

Gets or sets the output folder for code coverage.

Declaration

[Parameter("Output folder for code coverage")]
public AbsolutePath? CodeCoverageDirectory { get; set; }

Property Value

Type	Description
AbsolutePath

Configuration

Gets or sets the configuration to build.

Declaration

[Parameter("Configuration to build - 'Debug' (default for local build) or 'Release' (default for server)")]
public Configuration Configuration { get; set; }

Property Value

Type	Description
Configuration

CreateBinLog

Gets the target to create a binary compilation log file.

Declaration

protected Target CreateBinLog { get; }

Property Value

Type	Description
Target

Full

Gets the default target to run the full build.

Declaration

protected virtual Target Full { get; }

Property Value

Type	Description
Target

Interactive

Gets or sets a value indicating whether to interactively update packages.

Declaration

[Parameter("Whether to interactively update packages")]
public bool Interactive { get; set; }

Property Value

Type	Description
bool

NuGetDirectory

Gets or sets the output folder for NuGet packages.

Declaration

[Parameter("Output folder for NuGet packages")]
public AbsolutePath? NuGetDirectory { get; set; }

Property Value

Type	Description
AbsolutePath

PinnedPackages

Gets or sets the package IDs to skip updating dependencies.

Declaration

[Parameter("The package IDs to skip updating dependencies")]
public string[]? PinnedPackages { get; set; }

Property Value

Type	Description
string[]

Platform

Gets or sets the platform to build.

Declaration

[Parameter("Platform to build - default depends on the solution")]
public string? Platform { get; set; }

Property Value

Type	Description
string

PublishCoverageHTML

Gets or sets a value indicating whether to publish HTML to view test coverage.

Declaration

[Parameter("Whether to publish HTML to view test coverage")]
public bool PublishCoverageHTML { get; set; }

Property Value

Type	Description
bool

PublishDirectory

Gets or sets the output folder for binaries.

Declaration

[Parameter("Output folder for binaries")]
public AbsolutePath? PublishDirectory { get; set; }

Property Value

Type	Description
AbsolutePath

PublishFrameworks

Gets or sets the .NET target framework to publish.

Declaration

[Parameter(".NET target framework to publish - default depends on the solution")]
public string[]? PublishFrameworks { get; set; }

Property Value

Type	Description
string[]

PublishProjects

Gets or sets the .NET projects to publish.

Declaration

[Parameter(".NET projects to publish - default is the solution")]
public string[]? PublishProjects { get; set; }

Property Value

Type	Description
string[]

RunLintInCI

Gets or sets a value indicating whether lint source code in CI builds.

Declaration

[Parameter("Whether to lint source code in CI builds")]
public bool RunLintInCI { get; set; }

Property Value

Type	Description
bool

RunPackInCD

Gets or sets a value indicating whether publish NuGet artifacts in CD builds.

Declaration

[Parameter("Whether to publish NuGet artifacts in CD builds")]
public bool RunPackInCD { get; set; }

Property Value

Type	Description
bool

RunPublishInCD

Gets or sets a value indicating whether publish binary artifacts in CD builds.

Declaration

[Parameter("Whether to publish binary artifacts in CD builds")]
public bool RunPublishInCD { get; set; }

Property Value

Type	Description
bool

Solution

Gets or sets the solution to build.

Declaration

[Solution(SuppressBuildProjectCheck = true)]
public Solution? Solution { get; set; }

Property Value

Type	Description
Solution

TargetFramework

Gets or sets the .NET target framework to use.

Declaration

[Parameter(".NET target framework to use - default depends on the solution")]
public string? TargetFramework { get; set; }

Property Value

Type	Description
string

TestCollect

Gets or sets the data collector to use for the test run.

Declaration

[Parameter("Data collector to use for the test run")]
public string? TestCollect { get; set; }

Property Value

Type	Description
string

TestFilter

Gets or sets the filter for which tests to run.

Declaration

[Parameter("Filter for which tests to run")]
public string? TestFilter { get; set; }

Property Value

Type	Description
string

TestResultDirectory

Gets or sets the output folder for test results.

Declaration

[Parameter("Output folder for test results")]
public AbsolutePath? TestResultDirectory { get; set; }

Property Value

Type	Description
AbsolutePath

ValidatePublishOutput

Gets or sets a mapping from project name to its expected publish output.

Declaration

[Parameter("A mapping from project name to its expected publish output.")]
public string[]? ValidatePublishOutput { get; set; }

Property Value

Type	Description
string[]

ZipPublishOutput

Gets or sets a value indicating whether to create ZIP file of each published directory.

Declaration

[Parameter("Whether to create ZIP file of each published directory")]
public bool ZipPublishOutput { get; set; }

Property Value

Type	Description
bool

Methods

RunCD()

Runs continuous deployment.

Declaration

protected virtual void RunCD()

RunCI()

Runs continuous integration.

Declaration

protected virtual void RunCI()

RunCreateBinLog()

Creates a binary compilation log file.

Declaration

protected virtual void RunCreateBinLog()

Implements

IHasConfiguration

IHasPlatform

IHasTargetFramework

ILint

IPack

IPublish

IReportCoverage

ITest

ICompile

IHasGitVersion

IHasArtifacts

IUpdatePackages

IListOutdatedPackages

IRestore

Nuke.Common.INukeBuild

IHasSolution

Extension Methods

NukeBuildExtensions.IsInterceptorExecution(INukeBuild)

NukeBuildExtensions.DisableBuildExtension(NukeBuild, string)

NukeBuildExtensions.DisableBuildExtensions(NukeBuild, IEnumerable<string>)

NukeBuildExtensions.DisableTelemetry(NukeBuild)

NukeBuildExtensions.GetExecutableTargets(NukeBuild)

NukeBuildExtensions.SetExecutableTargets(NukeBuild, IReadOnlyCollection<ExecutableTarget>)