TaskSetup

This page was generated

Contributions are welcome in Psake-repo.

SYNOPSIS

Adds a scriptblock that will be executed before each task

SYNTAX

TaskSetup [-setup] <ScriptBlock> [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

This function will accept a scriptblock that will be executed before each task in the build script.

The scriptblock accepts an optional parameter which describes the Task being setup.

EXAMPLES

EXAMPLE 1

A sample build script is shown below:

Task default -depends Test

Task Test -depends Compile, Clean { }

Task Compile -depends Clean { }

Task Clean { }

TaskSetup { "Running 'TaskSetup' for task $context.Peek().currentTaskName" }

The script above produces the following output:

Running 'TaskSetup' for task Clean Executing task, Clean... Running 'TaskSetup' for task Compile Executing task, Compile... Running 'TaskSetup' for task Test Executing task, Test...

Build Succeeded

EXAMPLE 2

A sample build script showing access to the Task context is shown below:

Task default -depends Test

Task Test -depends Compile, Clean { }

Task Compile -depends Clean { }

Task Clean { }

TaskSetup { param($task)

"Running 'TaskSetup' for task $($task.Name)" }

The script above produces the following output:

Running 'TaskSetup' for task Clean Executing task, Clean... Running 'TaskSetup' for task Compile Executing task, Compile... Running 'TaskSetup' for task Test Executing task, Test...

Build Succeeded

PARAMETERS

-setup

A scriptblock to execute

Type: ScriptBlock
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.