Skip to main content

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​

__AllParameterSets​

TaskTearDown [-TearDown] <scriptblock> [<CommonParameters>]

DESCRIPTION​

Use this for per-task teardown such as logging duration, checking postconditions, or cleaning up temporary state. The completed [PsakeTask] is passed as an optional argument with success/error info.

EXAMPLES​

EXAMPLE 1​

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​

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​

Receives the completed task as an optional [PsakeTask] argument.

Type: System.Management.Automation.ScriptBlock
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters​

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

INPUTS​

OUTPUTS​

NOTES​

VERSION​

This page was generated using comment-based help in Psake 5.0.4.