BuildStep Task
The BuildStep task is a convenience task that adds, and potentially updates via the output ID property, a BuildStep.
Parameters
Parameter |
Description |
|---|---|
TeamFoundationServerUrl |
Specifies the Team Foundation Server URL. For example, http://MyServer:8080. |
BuildUri |
Specifies the build URI. |
Name |
Specifies the name of the build step that this task adds. |
Message |
Specifies the message that is displayed in the build report in the build steps section. |
Id |
Specifies the optional input/output parameter. If specified, this is the ID of the build step that is updated. If not specified, a new build step is created. |
Status |
Specifies the status for the build step. For example, Succeeded, Failed, or Stopped. |
Example
The following example creates and then updates a build step called MyBuildStep. It uses the Id parameter to refer to the build step.
When the first BuildStep task runs, the build report displays the message "My build step is executing." After the second BuildStep task has ran, the succeeded status icon appears next to the build step. For more information, see How to: View a Build Report and Walkthrough: Customizing Team Foundation Build with a Custom Task.
<BuildStep TeamFoundationServerUrl="$(TeamFoundationServerUrl)"
BuildUri="$(BuildUri)" Name="MyBuildStep"
Message="My build step is executing.">
<Output TaskParameter="Id" PropertyName="MyBuildStepId" />
</BuildStep>
<BuildStep TeamFoundationServerUrl="$(TeamFoundationServerUrl)"
BuildUri="$(BuildUri)" Id="$(MyBuildStepId)" Status="Succeeded" />
The following example creates a build step called MyBuildStep without using the Id parameter.
<BuildStep TeamFoundationServerUrl="$(TeamFoundationServerUrl)"
BuildUri="$(BuildUri)" Name="MyBuildStep"
Message="This is a status message." Status="Succeeded" />
See Also
Tasks
How to: Customize Build Numbers