NukeBuildExtensions Class

Definition

Extension methods for Nuke.Common.NukeBuild.

C#

public static class NukeBuildExtensions

Inheritance object

Fields

ForbiddenBuildExtensions

The build attributes which should be removed before executing Nuke.

C#

public static readonly ImmutableArray<string> ForbiddenBuildExtensions

Properties

TelemetryClient

Gets the Nuke telemetry client, if any.

C#

public static TelemetryClient? TelemetryClient { get; }

Methods

DisableTelemetry(NukeBuild)

Disables Nuke telemetry.

C#

public static void DisableTelemetry(this NukeBuild build)

Parameters

build Nuke.Common.NukeBuild
The build to modify.

GetExecutableTargets(NukeBuild)

Gets the targets.

C#

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

Parameters

build Nuke.Common.NukeBuild
The build.

Returns

IReadOnlyCollection<ExecutableTarget>
A collection of targets.

SetExecutableTargets(NukeBuild, IReadOnlyCollection)

Sets the targets.

C#

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

Parameters

build Nuke.Common.NukeBuild
The build.

targets IReadOnlyCollection<ExecutableTarget>
A collection of targets.

DisableBuildExtension(NukeBuild, string)

Disables a build extension.

C#

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

Parameters

build Nuke.Common.NukeBuild
The build to modify.

name string
The extension to remove.

DisableBuildExtensions(NukeBuild, IEnumerable)

Disables build extensions.

C#

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

Parameters

build Nuke.Common.NukeBuild
The build to modify.

names IEnumerable<string>
The extensions to remove.

Returns

bool
True if successful.

IsInterceptorExecution(INukeBuild)

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

C#

public static bool IsInterceptorExecution(this INukeBuild build)

Parameters

build Nuke.Common.INukeBuild
The build to modify.

Returns

bool
True if in interceptor mode.