Build Cache

Build Cache is currently available as an experimental feature and may be changed in future releases.

To enable this build feature, navigate to the Administration | Experimental Features page and tick the corresponding checkbox.

Build Cache feature can work in one- or two-way mode. In two-way mode it downloads caches published by the same feature during a previous build. When you add a new Build Cache feature, it is configured to operate in this mode.

In one-way mode one build configuration with the "Build Cache" feature publishes cache, and another build configuration downloads it. This mode allows you to set up "publisher" and "consumer" features to exchange caches between different build configurations of the same project.

This section illustrates how to set up the Build Cache feature that allows a build configuration to reuse caches from its own previous builds.

1. Add the build feature to a build configuration and specify a unique Cache Name.

2. Since we want the feature to both publish and use cache, leave both Publish and Use Cache settings enabled.

3. Specify paths to files and folders that should be cached (currently, only paths relative to the checkout directory are supported). Each path should start from a new line. Wildcards are not supported.

   The figure below illustrates the Build Cache feature configured to publish NodeJS packages downloaded by the npm install or yarn install build step.

   

4. Save the settings and ensure that the build feature description confirms that your feature both publishes and uses its cache.

   

5. Run the build. If you correctly set up the feature, you should be able to see required files published as a ".teamcity.build_cache" hidden artifact when the build finishes.

   

6. To confirm that cache published during the previous run is used, run the build again and check the build log.

   

In this setup, the "publisher" Build Cache feature added to one build configuration publishes its cache, while the "consumer" Build Cache feature added to another configuration downloads this cache to this configuration's checkout directory.

You can set up as many publisher and consumer features as required as long as you add features for configurations that belong to the same project.

tip

One Build Cache feature can publish and use only one cache archive. If you need to utilize caches published by multiple build configurations, add the corresponding number of Build Cache features.

The Build Cache feature is still under development, and we'd love to hear your early thoughts and suggestions. See this document for the information on how to send feedback to the TeamCity team: Feedback.

• Artifacts Cache on Agents

• Data Clean-Up