This documentation is archived and is not being maintained.

Walkthrough: Shelving Source Control Items

This walkthrough demonstrates using the shelving feature in Team Foundation source control.

Shelving lets you set aside a group of pending changes temporarily in order to work on another high priority release or to share your untested source file revisions with another user. The output of a shelve operation is a shelveset. For more information, see Working with Source Control Shelvesets.

Before you can complete this walkthrough you must:

If you are not familiar with these prerequisite steps, we recommend that you review Walkthrough: Exploring Team Foundation Source Control first.

You must have the following security permissions to complete this walkthrough:

  • PendChange

  • Checkin

For more information about Team Foundation source control security permissions, seeOverview of Team Foundation Security.

Required Permissions

To complete this walkthrough, you must have the PendChange and Checkin permissions. For more information, see Source Control Security Rights and Permissions.

The following procedure, describes a shelve action which lets you set aside the pending changes in your workspace temporarily. A shelve action can also be used to share your code with another user for code review.

Perform a Get Latest operation to synchronize your workspace with the latest server version, and then build your application to make sure that it compiles before shelving or checking in. Doing this lets you incorporate changes to source files that have been made outside your workspace. For more information, see How to: Update the Source in your Workspace.

The following procedure assumes that you have a solution with pending changes.

To shelve folders and files in source control

  1. In Solution Explorer, right-click, and select Shelve Pending Changes.


    The shelve option is also available in Source Control Explorer.

  2. In the Shelve - Source Files dialog box, type shelvetest in the Shelveset name box.

  3. In the Comment box, type Testing my shelveset and then click Shelve.

    The files and folders are copied to the source control server and are available for other team members to unshelve. For more information, see How to: Shelve and Unshelve Pending Changes.