Target

Nested types and modules

TypeDescription
DependencyType
OptionalTargetContext

Optional TargetContext

ModuleDescription
ParallelRunner
WithContext

Run functions which don't throw and return the context after all targets have been executed.

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.getBuildFailedException(context)
Signature: context:TargetContext -> BuildFailedException
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.getRunFunction(...)
Signature: allowArgs:bool -> defaultTarget:string option -> (unit -> TargetContext option) 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.raiseIfError(context)
Signature: context:OptionalTargetContext -> unit

If TargetContext option is Some and has error, raise it as a BuildFailedException

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
Attributes:
[<Obsolete("Use Target.WithContext.run instead")>]
OBSOLETE

Use Target.WithContext.run instead

Runs a target and its dependencies and returns a TargetContext

Target.runFunction(targetFunction)
Signature: targetFunction:Option<(unit -> TargetContext option)> -> OptionalTargetContext
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.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.updateBuildStatus(context)
Signature: context:OptionalTargetContext -> unit

Updates build status based on OptionalTargetContext Will not update status if OptionalTargetContext is MaybeSet with value None

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

Writes a build time report.