Version Control Process Template Plug-in
The version control plug-in defines a team project's initial version control security permissions, check-in notes, and whether exclusive check out is required. The plug-in name is Microsoft.ProjectCreationWizard.VersionControl. The version control XML file is named VersionControl.xml and is located in the Version Control folder in the process template folder hierarchy. You can change the XML file and folder name if it is required.
In the XML file, specify one or more tasks and their dependencies. Generally, you need only one task to configure version control settings. For an example of a task specifying version control settings, see the VersionControl.xml file in the MSF for Agile Software Development process template.
Note
Team Foundation Server does not include a mechanism for the deployment of client-side plug-ins, policies, or other modifications. If you want to deploy plug-ins, policies, or other modifications to Team Explorer, you must use your own distribution and installation program.
Check-in Notes
Check-in notes are provided by the developer when code is checked in to describe how, or if, the code changes are related to team processes. For example, a check-in note can indicate if the change was part of a security review, and include details about the changes relative to the security review.
Use the checkin_note element to define a check-in note.
<checkin_note label="" required="" order=""/>
The following table describes the attributes for the checkin_note element.
Attribute |
Description |
|---|---|
label |
The label that describes the check-in note. The label is displayed to the user on the Pending Check-ins dialog box when they perform a check-in. |
required |
Specifies if the check-in note is required to have a value. If set to true, the check-in note must have a value. If set to false, a value is optional. |
order |
Specifies an ordinal number to indicate what order to display the check-in notes. This attribute is optional. |
The following example shows how to customize the MSF for Agile Software Development check-in notes to provide an additional check-in note named "Documentation Impact" that is not required to have a value.
<taskXml>
<checkin_note label="Code Reviewer" required="false" order="1"/>
<checkin_note label="Security Reviewer" required="false" order="2"/>
<checkin_note label="Performance Reviewer" required="false" order="3"/>
<checkin_note label="Documentation Impact" required="false"/>
</taskXml>
Exclusive Check Out
You can control whether multiple people can check out a file at the same time. Use the exclusive_checkout element to specify the check-out properties.
<exclusive_checkout required=""/>
If the required attribute is set to true, only one person can check out a file at a time. If set to false, multiple people can check out a file at the same time, and they must reconcile changes when they check in the file.
The following example shows how to specify that exclusive check-out is required.
<exclusive_checkout required="true"/>
Get Latest on Check Out
You can configure the default check-out behavior for the team project. Use the get_latest_on_checkout element to specify the check-out behavior.
<get_latest_on_checkout required=""/>
If the required attribute is set to true, the latest version of an item, or tip, is downloaded every time you check it out. This behavior is similar to the check-out behavior in Visual SourceSafe.
If the required attribute is set to false, the check-out operation will check out the local version in your workspace. This is the default behavior.
The following example shows how to specify that the default check-out behavior is to get the latest version of items on check out.
<get_latest_on_checkout required="true"/>
Permissions
Version control has a specific set of permissions that you can configure for a process template. Specifying permissions will define what actions security groups and individuals can perform on items under version control.
Use the permission element to allow, deny, or allow and deny permissions for an identity.
<permission allow="" identity=""/>
<permission deny="" identity=""/>
<permission allow="" deny="" identity=""/>
The following table describes the attributes for the permission element.
Attribute |
Description |
|---|---|
allow |
Identifies the permissions being granted. The permissions are specified as comma-delimited text. |
deny |
Identifies the permissions being revoked. The permissions are specified as comma-delimited text. .gif "Note") Note:
Denied permissions take precedence over allowed permissions.
|
identity |
Specifies the Team Foundation Server security group, Windows group, or Windows identity to which this permission is applied. |
The following table describes the permissions you can specify for version control.
Permission |
Description |
|---|---|
Read |
Can read the contents of a file or folder. |
PendChange |
Can check out, add, delete, branch, merge, undelete, and perform other activities associated with a changeset. |
Checkin |
Can check in changes. |
Label |
Can apply a label to items. |
Lock |
Can lock an item so that others cannot update it. |
ReviseOther |
Can change the contents of someone else’s changeset comments and check-in notes. |
UnlockOther |
Can remove someone else’s lock. |
UndoOther |
Can undo someone else’s pending changes. |
LabelOther |
Can modify someone else’s label. |
AdminProjectRights |
Can configure security settings for version control. |
CheckinOther |
Can perform a check in as another user. This permission is required for conversion utilities. |
Note
During runtime, if a permission cannot be found for an identity, the permission is searched for in any other groups the identity belongs to. If the permission cannot be found, the default action is to deny the permission.
The following example shows how to grant permissions to allow the Contributors group to modify files under version control.
<taskXml>
<permission allow="Read, PendChange, Checkin, Label, Lock"
identity="[$$PROJECTNAME$$]\Contributors"/>
</taskXml>
See Also
Tasks
How to: Verify Version Control Changes
Concepts
Windows SharePoint Services Process Template Plug-in
Reports Process Template Plug-in
Groups and Permissions Process Template Plug-in
Team Foundation Check-Out Settings