Categorygithub.com/bitrise-steplib/bitrise-step-restore-carthage-cache
modulepackage
0.0.0-20240913120314-0eddee817eb0
Repository: https://github.com/bitrise-steplib/bitrise-step-restore-carthage-cache.git
Documentation: pkg.go.dev

# README

Restore Carthage Cache

Step changelog

Restores cached Carthage dependencies. This Step needs to be used in combination with Save Carthage Cache.

Description

Restores cached Carthage prebuilt frameworks. This Step needs to be used in combination with Save Carthage Cache.

This Step is based on key-based caching and sets up the cache key and path automatically for Carthage dependencies. If you'd like to change the cache keys, you might want to use the generic Restore cache Step instead.

Related steps

Save Carthage cache

Save Cocoapods cache

Save SPM cache

Save 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.

Examples

Minimal example

steps:
- restore-carthage-cache@1: {}
- carthage@3:
    inputs:
      carthage_command: bootstrap
      carthage_options: --use-xcframeworks --platform iOS
- xcode-test@2:
    inputs:
      scheme: MyScheme
- save-carthage-cache@1: {}

Check out Workflow Recipes for other caching examples!

⚙️ Configuration

Inputs
KeyDescriptionFlagsDefault
verboseEnable logging additional information for troubleshootingrequiredfalse
Outputs
Environment VariableDescription
BITRISE_CACHE_HITIndicates if a cache entry was restored. Possible values: - exact: Exact cache hit for the first requested cache key - partial: Cache hit for a key other than the first - false No cache hit, nothing was restored

🙋 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.

Note: this step's end-to-end tests (defined in e2e/bitrise.yml) are working with secrets which are intentionally not stored in this repo. External contributors won't be able to run those tests. Don't worry, if you open a PR with your contribution, we will help with running tests and make sure that they pass.

Learn more about developing steps:

# Packages

No description provided by the author