Optimize your workspace
Azure Repos | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018-TFS 2013
Visual Studio 2019 | Visual Studio 2017 | Visual Studio 2015 | Visual Studio 2013
Does your team have a large and complex codebase? Do you want your workspace to contain only the files you need to improve performance, reduce network traffic, and reduce the disk space required on your dev machine?
- Optimize your folder names
- Optimize your workspace using explicit, implicit, cloaked, and non-recursive folder mappings
- Use workspaces to isolate and manage work among different branches
Branching or suspending (or shelving) are the preferred ways to isolate different work efforts against the same codebase. However, if neither of these approaches meets your needs, you can map the same server folder in more than one workspace. In most cases you should not need to do this. If you do map the same server folder in more than one workspace, remember that you could have separate and different pending changes to the same file stored in each workspace.
Optimize your folder names
If you don't yet use branches, on your server, you should put all your code in a subfolder called Main (for example:
$/TFVCTeamProject/Main/). If you do, then you'll be ready when your team grows big enough to require branches to manage your codebase. On your dev machine, you should use a short, understandable folder path that matches your project structure such as
Some more tips on effective folder names:
Keep all folder, sub-folder, and file names short to simplify your work and avoid potential long-path issues that can occur with some types of code projects.
Avoid whitespace if you want to make command-line operations a little easier to perform.
Optimize your workspace using explicit, implicit, cloaked, and non-recursive folder mappings
If your codebase is large, you can avoid wasting time, network bandwidth, and local disk space by optimizing your workspace folder mappings.
When you map a folder, make sure that you choose a folder high enough in the code tree that you get all the files you need to create a local build, but low enough that you are not getting more files than you need. You can also use some tools to more simply and quickly create a usable workspace: explicit, implicit, cloaked, and non-recursive folder mappings.
When you look at the workspace of fictitious developer, Raisa, below, you might wonder to yourself: why didn't she simply map
c:\\code\\SiteApp\\ and be done with it? A simple workspace like this would implicitly map all the folders she needs in
The main problem with this approach is that it would also provide her with a lot of files she does not need, and thus waste time and resources. So Raisa creates some tailored folder mappings.
Raisa doesn't develop customized build processes so she doesn't need
$/SiteApp/BuildProcessTemplates. Over time she expects the codebase to grow, and she also does not want to automatically download every new bit of code added to
$/SiteApp/Main/. As teams working in those other folders change those files, when Raisa gets the latest files from the server, she could incur long delays waiting for updates to files she doesn't need.
To develop her code, Raisa needs all the code projects that comprise the FabrikamFiber solution. Rather than explicitly including each code project (for example,
$/SiteApp/Main/FabrikamFiber/FabrikamFiber.DAL) she instead maps
$/SiteApp/Main/FabrikamFiber/, and thus she implicitly maps all the sub-folders that contain the code projects she needs.
Raisa does not need the files in
$/SiteApp/Main/FabrikamFiber/Docs, and because they are implicitly mapped by, she uses two cloaked mappings to exclude these folders from her workspace.
Raisa and others on her team maintain and sometimes augment a set of some fundamental libraries. She needs almost all current libraries in this folder and expects to need libraries her team adds there in the future, so she maps
Raisa needs only a small segment of a large folder,
$/SiteApp/Main/libraries/Common/LibraryC, so she maps it as cloaked and then explicitly maps just the sub-folder she needs:
Raisa needs some of the files immediately within
LibraryD, but she does not need the large contents of its sub-folders, so she applies a non-recursive mapping to this folder:
Use workspaces to isolate and manage work among different branches
If your company uses branches to isolate risk in your codebase, then you should create a separate workspace for each branch you work in.
For example, at Fabrikam Fiber, the codebase and the staff have grown. To isolate the risk among their many teams, they've branched their codebase. Raisa continues her work within her small team, but now she uses a few workspaces to manage the work that she now does in multiple branches.
Develop features She modifies her default workspace to do work in the Extranet branch, where she participates in the development of the customer-facing website in this branch.
Integrate and stabilize She creates two new workspaces to do work in the Test and Dev branches, where she collaborates with other developers and testers to stabilize the code during integration.
Raisa manages her work in three workspaces, each of which maps folders in a branch on the server with the folders on her dev machine.