Class NukeBuildExtensions

Extension methods for Nuke.Common.NukeBuild.

Inheritance

object

NukeBuildExtensions

Inherited Members

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

public static class NukeBuildExtensions

Fields

ForbiddenBuildExtensions

The build attributes which should be removed before executing Nuke.

Declaration

public static readonly ImmutableArray<string> ForbiddenBuildExtensions

Field Value

Type	Description
ImmutableArray<string>

Properties

TelemetryClient

Gets the Nuke telemetry client, if any.

Declaration

public static TelemetryClient? TelemetryClient { get; }

Property Value

Type	Description
TelemetryClient

Methods

DisableBuildExtension(NukeBuild, string)

Disables a build extension.

Declaration

public static void DisableBuildExtension(this NukeBuild build, string name)

Parameters

Type	Name	Description
NukeBuild	build	The build to modify.
string	name	The extension to remove.

DisableBuildExtensions(NukeBuild, IEnumerable<string>)

Disables build extensions.

Declaration

public static bool DisableBuildExtensions(this NukeBuild build, IEnumerable<string> names)

Parameters

Type	Name	Description
NukeBuild	build	The build to modify.
IEnumerable<string>	names	The extensions to remove.

Returns

Type	Description
bool	True if successful.

DisableTelemetry(NukeBuild)

Disables Nuke telemetry.

Declaration

public static void DisableTelemetry(this NukeBuild build)

Parameters

Type	Name	Description
NukeBuild	build	The build to modify.

GetExecutableTargets(NukeBuild)

Gets the targets.

Declaration

public static IReadOnlyCollection<ExecutableTarget>? GetExecutableTargets(this NukeBuild build)

Parameters

Type	Name	Description
NukeBuild	build	The build.

Returns

Type	Description
IReadOnlyCollection<ExecutableTarget>	A collection of targets.

IsInterceptorExecution(INukeBuild)

Gets a value indicating whether Nuke is executing in "interceptor" mode.

Declaration

public static bool IsInterceptorExecution(this INukeBuild build)

Parameters

Type	Name	Description
INukeBuild	build	The build to modify.

Returns

Type	Description
bool	True if in interceptor mode.

SetExecutableTargets(NukeBuild, IReadOnlyCollection<ExecutableTarget>)

Sets the targets.

Declaration

public static void SetExecutableTargets(this NukeBuild build, IReadOnlyCollection<ExecutableTarget> targets)

Parameters

Type	Name	Description
NukeBuild	build	The build.
IReadOnlyCollection<ExecutableTarget>	targets	A collection of targets.