step.yml

title: Restore xcodebuild Bitrise Build Cache
summary: Restores the DerivedData folder and related metadata used by xcodebuild. Uses the Bitrise Build Cache infrastructure.
description: |
  This step restores the DerivedData folder and the related metadata required to speed up subsequent builds.

  As xcodebuild only reuses DerivedData if the input files' modification time is the same, the step also restores the modification time of the input files (project files including source code files) from a metadata file stored along the
  DerivedData folder. Please use the same build settings as when the cache was saved to ensure the cache can be reused.

  NOTE: you need to have an activate Bitrise Build Cache Trial or Subscription for your workspace to use this step.
website: https://github.com/bitrise-steplib/bitrise-step-restore-xcodebuild-cache
source_code_url: https://github.com/bitrise-steplib/bitrise-step-restore-xcodebuild-cache
support_url: https://github.com/bitrise-steplib/bitrise-step-restore-xcodebuild-cache

project_type_tags:
- ios
- cordova
- ionic
- react-native
- flutter

type_tags:
- utility

run_if: .IsCI
is_skippable: true

toolkit:
  bash:
    entry_file: step.sh

deps:
  brew:
  - name: zstd

inputs:
- project_root_path: .
  opts:
    title: Project root path
    summary: Path to the root folder of the project to be built
    description: |-
      This needs to be set to the root folder of the project to be built. The step takes the metadata of the input files from this folder.

      When the cache is restored, the metadata of the files in this folder is restored as well. This ensures Xcode recognizes the cached DerivedData folder.
    is_required: false

- force_overwrite_files: "false"
  opts:
    title: Force overwrite files
    summary: Overwrite existing files even if the permissions do not allow it
    is_required: true
    value_options:
    - "true"
    - "false"

- skip_existing_files: "false"
  opts:
    title: Skip existing files
    summary: Skip downloading and overwriting existing files
    is_required: true
    value_options:
    - "true"
    - "false"

- verbose: "false"
  opts:
    title: Verbose logging
    summary: Enable logging additional information for troubleshooting
    is_required: true
    value_options:
    - "true"
    - "false"