GenCheckinNotesUpdateWorkItems Task
The GenCheckinNotesUpdateWorkItems task associates changesets and work items with a specified build, and optionally updates the Microsoft.VSTS.Build.IntegrationBuild field of the work items. The associated changesets and affected work items are those that are committed or affected between the versions specified by the LastLabel and the CurrentLabel properties.
Parameters
| Property | Description |
|---|---|
TeamFoundationServerUrl |
Specifies the Team Foundation Server URL. For example, https://MyServer:8080. |
BuildId |
Specifies the Team Foundation Build build number. |
CurrentLabel |
Specifies the version number label to which the changesets and work items are associated. Typically this is the label of the sources used in the current build. |
LastLabel |
Specifies the starting version number label from which the changesets and work items are associated. Typically this is the label of the sources used in the previous build. |
UpdateWorkItems |
Boolean property that specifies whether the Microsoft.VSTS.Build.IntegrationBuild of the associated work items should be updated with the build number. For more information about the Microsoft.VSTS.Build.IntegrationBuild, see Adding Integration Fields in Work Item Types. |
Remarks
The GenCheckinNotesUpdateWorkItems task is defined in the Microsoft.TeamFoundation.Build.Tasks.VersionControl.dll. The Microsoft.TeamFoundation.Build.targets file contains an instance of the GenCheckinNotesUpdateWorkItems task that Team Foundation Build uses as a default implementation for the GetChangeSetsAndUpdateWorkItems target. You can also customize the build process by defining a different instance of the GenCheckinNotesUpdateWorkItems task for a build type in the TfsBuild.proj file. For more information about how to customize a task, see How to: Modify the Scope of Changesets and Work Items Associated With a Build Type.
The Microsoft.TeamFoundation.Build.targets file is stored in the <root>:\Program Files\MSBuild\Microsoft\VisualStudio\v8.0\TeamBuild folder on the Team Foundation Build computer.
Example
The following example shows the default instance of the GenCheckinNotesUpdateWorkItems task as defined in the Microsoft.TeamFoundation.Build.targets file.
<GenCheckinNotesUpdateWorkItems
TeamFoundationServerUrl="$(TeamFoundationServerUrl)"
BuildId="$(BuildNumber)"
CurrentLabel="L$(BuildNumber)$(LabelQueryScope)"
LastLabel="L$(LastGoodBuildNumber)$(LabelQueryScope)"
UpdateWorkItems="$(UpdateAssociatedWorkItems)"
ContinueOnError="true" />
See Also
Tasks
How to: Customize Build Numbers
Reference
Changeset Command
Label Command (Team Foundation Source Control)
Concepts
Submitting Changes to the Source Control Server
Managing Team Foundation Work Items
Team Foundation Build Tasks
Other Resources
Customizing Team Foundation Build
Team Foundation Build Targets, Tasks, and Properties