Add Check-In Policies

Administrators of Team Foundation version control can add check-in policy requirements. These check-in policies require the user to take actions when they conduct a check-in to source control, for example a user can be required to associate a work item with a changeset. For more information about check-ins, see Check In Pending Changes. By default, the following check-in policy types are available:

  • Builds   Requires that the last build was successful before a check-in.

  • Code Analysis   Requires that code analysis is run before check-in.

  • Testing Policy   Requires that certain tests are completed before check-in.

  • Work Items   Requires that one or more work items be associated with the check-in.

Required Permissions

To complete this procedure, you must have the Edit project-level information permission set to Allow. For more information, see Team Foundation Server Permissions.


To create a check-in policy

  1. From Team Explorer, right-click your team project, click Team Project Settings, and then click Source Control.

    The Source Control Settings dialog box appears.

  2. Click the Check-in Policy tab and then click Add.

    The Add Check-in Policy dialog box appears.

  3. In the Check-in Policy list, select the policy type you want and then click OK.

    The list includes the following selections:

    • Select Builds if you want to require that a previous build was successful before any new changes can be checked in.

    • Select Code Analysis if you want to require that code analysis is run before code can be checked in. The Code Analysis Policy Editor dialog box appears.

      Select the check boxes for the types of code analysis that you want performed. Options are Enforce check-in to only contain files that are part of current solution, Enforce C/C++ Code Analysis (/analyze), and Enforce Code Analysis For Managed Code. If you select the Enforce Code Analysis For Managed Code check box, select the desired rule settings under Rule settings for Managed Code Analysis.

      For more information about how to use code analysis tools, see Creating and Using Code Analysis Check-In Policies.

      When you are finished, click OK.

    • Select Testing Policy if you want to require that certain tests are run before code can be checked in. The Testing Policy dialog box appears.

      Click Browse. In the Browse dialog box, specify a metadata file, and click OK. In the Testing Policy dialog box, select the check boxes for the test lists whose tests must be run to satisfy the check-in policy.

      (Optional) Select the Apply check-in policy only to tests impacted by code changes check box if you want to restrict the policy on this criterion.

      For more information, see Create Test Settings to Run Automated Tests from Visual Studio and Defining Test Lists to Group Your Tests.

    • If you selected Work Items, the policy is added to the list that a work item must be associated with the check in.

  4. When you are satisfied with the settings for the check-in policies, click OK; the new check-in policy now displays with future check-ins.

See Also


How to: Create a Test List


Configure Command


Set and Enforce Quality Gates

Other Resources

Walkthrough: Customizing Checkin Policies and Notes