Build Cache for Xcode

Activates Bitrise Remote Build Cache add-on for subsequent Xcode builds in the workflow

Description

This Step enables Bitrise's Build Cache Add‑On for Xcode by configuring the environment with the Build Cache CLI.

After this Step runs, Xcode builds invoked via xcodebuild in subsequent workflow steps will automatically read from the remote cache and push new entries when applicable.

The Step adds an alias to ~/.zshrc and ~/.bashrc so the wrapper is available in all following steps; from that point all xcodebuild calls are wrapped to enable compilation caching. Analytical data (command, duration, cache information, environment) is collected and sent to Bitrise and is available on the Build cache page: https://app.bitrise.io/build-cache

🧩 Get started

Add this step directly to your workflow in the Bitrise Workflow Editor.

You can also run this step directly with Bitrise CLI.

⚙️ Configuration

Inputs

Key	Description	Flags	Default
verbose	Enable logging additional information for troubleshooting	required	false
cache	Whether the build uses the remote cache	required	true
push	Whether the build can not only read, but write new entries to the remote cache	required	true
silent	Whether Bitrise components should not log anything except the underlying xcodebuild output. Takes precedence over the 'Verbose logging' and 'Add timestamps' options.	required	false
timestamps	When enabled, the analytics wrapper adds timestamps to xcodebuild output log messages during the build.	required	false
cache_skip_flags	Skip passing cache flags to xcodebuild except the COMPILATION_CACHE_REMOTE_SERVICE_PATH. Cache will have to be enabled manually in the Xcode project settings. More information can be found at the FAQ document: https://docs.bitrise.io/en/bitrise-build-cache/build-cache-for-xcode/xcode-compilation-cache-faq.html	required	false

Outputs

There are no outputs defined in this step

🙋 Contributing

We welcome pull requests and issues against this repository.

For pull requests, work on your changes in a forked repository and use the Bitrise CLI to run step tests locally.

Learn more about developing steps:

• Create your own step