GenCheckinNotesUpdateWorkItems Task
The GenCheckinNotesUpdateWorkItems task associates changesets and work items with a specified build. Also, you have the option of using it to update 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, http://MyServer:8080. |
BuildUri |
Specifies the build URI. |
BuildNumber |
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.
The <root>:\Program Files\MSBuild\Microsoft\VisualStudio\TeamBuild folder on the Team Foundation Build computer contains the Microsoft.TeamFoundation.Build.targets file.
Example
The following example shows the default instance of the GenCheckinNotesUpdateWorkItems task as defined in the Microsoft.TeamFoundation.Build.targets file.
<GenCheckinNotesUpdateWorkItems
TeamFoundationServerUrl="$(TeamFoundationServerUrl)"
BuildUri="$(BuildURI)"
BuildNumber="$(BuildNumber)"
CurrentLabel="$(LabelName)$(LabelScope)"
LastLabel="$(LastGoodBuildLabel)"
UpdateWorkItems="$(UpdateAssociatedWorkItems)"
ContinueOnError="true" />
See Also
Tasks
How to: Customize Build Numbers
Concepts
Submitting Changes to the Version Control Server
Working with Team Foundation Work Items
Reference
Label Command (Team Foundation Version Control)