|You are viewing documentation of TeamCity 4.x, which is not the most recent released version of TeamCity. Please refer to the listing to choose another version.|
The build checkout directory is the directory where all of the project's sources reside. If the VCS checkout mode property of the build configuration is set to Automatically on server or Automatically on agent, TeamCity places the sources into the checkout directory according to the mapping defined in the VCS Checkout Rules.
If not specified, automatically created directory is used with a generated name: <Agent Working Directory>/<VCS settings hash code>. The VCS settings hash code is calculated based on VCS roots and VCS settings used by the build configuration. Effectively, this means that the directory is shared between all the build configurations with the same VCS settings.
If you need to know the directory used by a build configuration, you can refer to <Agent Working Directory>/directory.map generated file which lists build configurations with the directory used by them.
If for some reason default directory does not match your requirements (for example, the process of creating builds depends on some particular directory), you may want to specify your own build checkout directory.
As a kind of failover measure TeamCity automatically performs Clean Checkout, if it finds files of another build configuration in the current checkout directory or the directory is empty.
Checkout directories are automatically deleted from disk if not used (no builds use it as checkout directory) for a specified period of time (8 days by default). This behavior only applies to default checkout directories (explicitly specified checkout directories are not cleaned).
The time frame can be changed by specifying new value (in hours) by either of the following ways:
Setting the property to "0" will cause deleting the checkout directories right after the build finish.
When a build's sources are checked out to a Build Checkout Directory on a build agent and before the build is started to run, TeamCity checks the available free space. By default, the required free space is 3Gb.
Required free space value is defined by the following properties:
TeamCity checks the values in the following order:
Generally, the teamcity.agent.ensure.free.space property value is set in bytes. Also, you can specify the value in kb, mb, gb, kib, mib, or gib.
If build agent does not have required free space under temp or build checkout folders, .old directories cleanup is started.