TaskTearDown

This page was generated

Contributions are welcome in Psake-repo.

SYNOPSIS

Adds a scriptblock to the build that will be executed after each task

SYNTAX

TaskTearDown [-teardown] <ScriptBlock> [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

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

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

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 { }

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

The script above produces the following output:

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

Build Succeeded

EXAMPLE 2

A sample build script demonstrating access to the task context is shown below:

Task default -depends Test

Task Test -depends Compile, Clean { }

Task Compile -depends Clean { }

Task Clean { }

TaskTearDown { param($task)

if ($task.Success) { "Running 'TaskTearDown' for task $($task.Name) - success!" } else { "Running 'TaskTearDown' for task $($task.Name) - failed: $($task.ErrorMessage)" } }

The script above produces the following output:

Executing task, Clean... Running 'TaskTearDown' for task Clean - success! Executing task, Compile... Running 'TaskTearDown' for task Compile - success! Executing task, Test... Running 'TaskTearDown' for task Test - success!

Build Succeeded

PARAMETERS

-teardown

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.