Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

Target

Functions and values

Function or valueDescription
Target.activateBuildFailure(name)
Signature: name:string -> unit

Activates the build failure target.

Target.activateFinal(name)
Signature: name:string -> unit

Activates the final target.

Target.create name body
Signature: name:string -> body:(TargetParameter -> unit) -> unit

Creates a Target.

Target.createBuildFailure name body
Signature: name:string -> body:(TargetParameter -> unit) -> unit

Creates a target in case of build failure (not activated).

Target.createFinal name body
Signature: name:string -> body:(TargetParameter -> unit) -> unit

Creates a final target (not activated).

Target.deactivateBuildFailure(name)
Signature: name:string -> unit

Deactivates the build failure target.

Target.deactivateFinal(name)
Signature: name:string -> unit

deactivates the final target.

Target.DoNothing(_arg1)
Signature: _arg1:TargetParameter -> unit
Attributes:
[<Obsolete("Use ignore instead")>]
OBSOLETE

Use ignore instead

Do nothing - Can be used to define empty targets.

Target.get(name)
Signature: name:string -> Target

Gets a target with the given name from the target dictionary.

Target.listAvailable()
Signature: unit -> unit

List all targets available.

Target.printDependencyGraph(...)
Signature: verbose:bool -> target:string -> unit

Writes a dependency graph.

Target.removeLastDescription
Signature: unit -> unit
Target.run parallelJobs targetName args
Signature: parallelJobs:int -> targetName:string -> args:string list -> unit

Runs a target and its dependencies

Target.runAndGetContext(...)
Signature: parallelJobs:int -> targetName:string -> args:string list -> TargetContext

Runs a target and its dependencies, used for testing - usually not called in scripts.

Target.runOrDefault(defaultTarget)
Signature: defaultTarget:string -> unit

Runs the command given on the command line or the given target when no target is given

Target.runOrDefaultWithArguments(...)
Signature: defaultTarget:string -> unit

Runs the command given on the command line or the given target when no target is given

Target.runOrList()
Signature: unit -> unit

Runs the target given by the target parameter or lists the available targets

Target.runSimple name args
Signature: name:string -> args:string list -> TargetResult

This simply runs the function of a target without doing anything (like tracing, stopwatching or adding it to the results at the end)

Target.runSimpleWithContext name ctx
Signature: name:string -> ctx:TargetContext -> TargetResult

This simply runs the function of a target without doing anything (like tracing, stopwatching or adding it to the results at the end)

Target.setLastDescription
Signature: string -> unit
Target.setPrintStackTraceOnError
Signature: bool -> unit