The caching will tar all the cached directories and dependencies, and store them securely in Amazon S3.
Bitrise steps for caching ⚓
All you need to get started is adding two steps to your Workflow:
Bitrise.io Cache:Pullstep to download the previous cache (if any).
Bitrise.io Cache:Pushstep to check the state of the cache and upload it if required.
You should add the
Bitrise.io Cache:Pull (download) step right before you’d use the cache.
For example, in the case of an iOS app, you can insert the
Bitrise.io Cache:Pull step between the
Git Clone Repository and the dependency installer steps (for example, the
Run CocoaPods install or
Carthage steps). You should not put the
Bitrise.io Cache:Pull step BEFORE the
Git Clone Repository step.
Bitrise.io Cache:Push step should be the very last step in the workflow.
You can find example build cache configurations/guides at our build-cache discuss page.
Ignore files/dependencies ⚓
You can set the path to the items you want the cache to ignore in the
Ignore Paths from change check field.
- Paths must be prefixed with
!to get ignored from the cache archive. If you don’t prefix the path with an
!, the path will NOT get ignored from the cache archive. If a path is located inside a specified cache path item and the path is NOT prefixed with an
!, the path will be included in the cache archive, but it will not be checked for changes.
To ignore a path element, part of a path or exclude a full directory, check out these elements:
*replaces a path element, for example,
**replaces a part of the path, for example,
/excludes a full directory if
/is placed AFTER a directory, for example,
/my/full/pathwill look like this
Download and delete caches ⚓
You can download and delete caches for every branch which generated a cache in the
Manage Build Caches section of your app’s
You can see the size of the caches and the last time a given cache was used in the popup window.
Technical notes ⚓
Build Cache feature ⚓
The Build Cache feature is split into two parts, the
Build Cache API and the
Build Cache API is a simple API, with only one responsibility: you can request a download or an upload URL from the API.
It also makes sure that you have the required access rights to the resource (Build Cache Archive), but other than that its only responsibility is providing the secure - time-limited and expiring - download and upload URLs.
It does not process the files.
The Steps are the place where the “magic” happens. The whole logic of comparing caches (to see if there was any relevant change) and creating the cache archives is done by the Steps. This also means that you can write your own Steps and implement your own comparison and compression logic. The Step just has to use the Build Cache API to get download and upload URLs, there’s no restriction on the cache file format or on its content.
A couple more handy tips:
- You can create your own Cache steps
- You can create and use your own Build Cache server and API
The cache might or might not be available ⚓
You should write your code in a way that it won’t fail if the cache can’t be accessed.
The cache is downloaded over the internet ⚓
This means that if you store files which are downloaded from a CDN/cloud storage, you might not see any speed improvement, as downloading it from the Bitrise Build Cache storage will probably take about the same time as downloading it from its canonical CDN/cloud storage location.
The cache is stored as one archive file ⚓
So if you have multiple paths you want to cache and any of the paths gets updated, it’ll update the whole cache archive, including all the paths you cache.
If a build runs on a branch which doesn’t have a cache yet, it’ll get the cache of the main/default branch ⚓
The build on a non-default branch, to speed things up, can access (read-only) the cache of the
primary branch, until a successful build is found on the new branch. Once a build on the new branch pushes a cache, new builds on that branch will get the cache of the branch. Caches are stored and available for every branch separately.
You can see which is your default branch if you click the
Settings tab of your app.
If a build was started with a code push, the cache will be available on the push branch and will be pulled from the same push branch. If you start a Pull Request (PR), the cache of the PR source branch will be pulled and pushed to the same source branch. In the case of a tag event, there is no code change so there is nothing to cache.