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

Nested types and modules

TypeDescription
DependencyType
ModuleDescription
ParallelRunner

Functions and values

Function or valueDescription
Target.( <== ) x ys
Signature: x:string -> ys:string list -> unit

Backwards dependencies operator - x is dependent on ys.

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.dependencyString(target)
Signature: target:Target -> string

Returns the DependencyString for the given target.

Target.determineBuildOrder(target)
Signature: target:string -> Target [] list

Determines a parallel build order for the given set of targets

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.getAllTargetsNames()
Signature: unit -> string list

Returns a list with all target names.

Target.getBuildFailureTargets
Signature: unit -> Dictionary<string,bool>

BuildFailureTargets - stores build failure targets and if they are activated.

Target.getFinalTargets
Signature: unit -> Dictionary<string,bool>

Final Targets - stores final targets and if they are activated.

Target.getLastDescription
Signature: unit -> string option
Target.getPrintStackTraceOnError
Signature: unit -> bool option
Target.getTargetDict
Signature: unit -> Dictionary<string,Target>
Target.handleUserCancelEvent cts e
Signature: cts:CancellationTokenSource -> e:ConsoleCancelEventArgs -> unit
Target.listAvailable()
Signature: unit -> unit

List all targets available.

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

Writes a dependency graph.

Target.printRunningOrder(targetOrder)
Signature: targetOrder:Target [] list -> unit
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.runInternal(...)
Signature: singleTarget:bool -> parallelJobs:int -> targetName:string -> args:string list -> TargetContext

Runs a target and its dependencies.

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.runSimpleContextInternal(...)
Signature: traceStart:(string -> string -> string -> ISafeDisposable) -> context:TargetContext -> target:Target -> TargetContext
Target.runSimpleInternal context target
Signature: context:TargetContext -> target:Target -> TargetResult
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.runSingleTarget target context
Signature: target:Target -> context:TargetContext -> TargetContext

Runs a single target without its dependencies... only when no error has been detected yet.

Target.runWithDefault allowArgs fDefault
Signature: allowArgs:bool -> fDefault:(bool -> int -> string list -> unit) -> unit
Target.setLastDescription
Signature: string -> unit
Target.setPrintStackTraceOnError
Signature: bool -> unit
Target.softDependencyString(target)
Signature: target:Target -> string

Returns the soft DependencyString for the given target.

Target.visitDependencies(...)
Signature: fVisit:(Target * DependencyType * int * bool -> unit) -> targetName:string -> HashSet<string> * List<string>
Target.withDependencyType(...)
Signature: depType:DependencyType -> targets:'?17490 list -> (DependencyType * '?17490) list
Type parameters: '?17490
Target.writeTaskTimeSummary(...)
Signature: total:'?17495 -> context:TargetContext -> unit
Type parameters: '?17495

Writes a build time report.