Setup Cache


Setup Cache accelerates the build initialization phase by caching compute-intensive inputs that build tools must process before the actual build begins.

In a typical cold CI run, Gradle must recompile build scripts, parse configurations, and calculate file hashes before executing any build tasks. Setup Cache eliminates this repeated work by storing and restoring these initialization inputs through Develocity Edge nodes close to your CI infrastructure.

To use Setup Cache, the Setup Cache entitlement must be enabled on your Develocity license.

Setup Cache is supported for Gradle builds only.

For the complete reference and setup instructions, consult the Artifact Cache CLI User Manual.

How It Works

Setup Cache operates through the same Artifact Cache CLI and Edge infrastructure as Artifact Cache, following the same restore-build-store cycle. The difference is in what gets cached:

  • Artifact Cache caches build dependencies downloaded from external repositories.

  • Setup Cache caches build initialization inputs such as compiled build scripts, resolved configurations, and other toolchain artifacts.

During the restore phase, the CLI retrieves both dependency artifacts and setup inputs (when both entitlements are enabled), reducing the time before the first build task executes.

Key Administrative Tasks

Setup Cache is configured and managed through the same CLI as Artifact Cache. For detailed instructions, refer to the following sections in the Artifact Cache CLI User Manual:

Requirements

  • A Develocity license with the Setup Cache entitlement enabled

  • At least one Develocity Edge node deployed near your CI infrastructure

  • Java 21 or later installed on CI agents

  • A Develocity access key with "Read and write Build Cache data" permission

Setup Cache supports Gradle 8.1+ only.

For full requirements including version compatibility and Edge storage sizing, see the System Requirements page.

Technical Notes

  • Gradle only: Setup Cache isn’t available for Maven or npm builds.

  • Permissions: CI agent users require a Develocity access key with the "Read and write Build Cache data" permission.

  • Connectivity: CI agents must have network access to both the Develocity server (HTTP/1) and a Develocity Edge node (HTTP/2). Co-locate CI runners and Edge nodes in the same availability zone to minimize latency.

  • Combined use: When both Artifact Cache and Setup Cache entitlements are enabled, the CLI handles both in a single restore-store cycle. Use the --disable-artifact-cache or --disable-setup-cache flags to selectively disable either cache.