step.yml

title: Save SPM Cache
summary: Saves Swift Package Manager dependency cache. This Step needs to be used in combination with **Restore SPM Cache**.
description: |
  Saves Swift Package Manager dependency cache. This Step needs to be used in combination with **Restore SPM Cache**.

  This Step is based on [key-based caching](https://devcenter.bitrise.io/en/builds/caching/key-based-caching.html) and sets up the cache key and path automatically for SPM dependencies. If you'd like to change the cache key (or paths to cache), you might want to use the generic [Save cache](https://github.com/bitrise-steplib/bitrise-step-save-cache) Step instead.

  #### Related steps

  [Restore SPM cache](https://github.com/bitrise-steplib/bitrise-step-restore-spm-cache/)

  [Save cache](https://github.com/bitrise-steplib/bitrise-step-save-cache/)

website: https://github.com/bitrise-steplib/bitrise-step-save-spm-cache
source_code_url: https://github.com/bitrise-steplib/bitrise-step-save-spm-cache
support_url: https://github.com/bitrise-steplib/bitrise-step-save-spm-cache/issues

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

run_if: .IsCI
is_skippable: true

toolkit:
  go:
    package_name: github.com/bitrise-steplib/bitrise-step-save-spm-cache

deps:
  brew:
  - name: zstd

inputs:
- derived_data_path: ~/Library/Developer/Xcode/DerivedData/**
  opts:
    title: Derived Data Path
    summary: Path of the project's Derived Data folder.
    description: Path of the project's Derived Data folder. Supports glob patterns.
    is_required: false
- project_path: $BITRISE_PROJECT_PATH
  opts:
    title: Xcode Project path. Used to automatically find Derived Data path, only when `Derived Data Path` is empty (not provided).
    summary: Path of the Xcode Project (`.xcodeproj`), Workspace (`.xcworkspace`) or Swift package (`Package.swift`)
    description: |-
      Xcode Project (`.xcodeproj`) or Workspace (`.xcworkspace`) path.

      If this is a Swift package, this should be the path to the `Package.swift` file.
    is_required: false
- verbose: "false"
  opts:
    title: Verbose logging
    summary: Enable logging additional information for troubleshooting
    is_required: true
    value_options:
    - "true"
    - "false"
- compression_level: 3
  opts:
    title: Compression level
    summary: Zstd compression level to control speed / archive size. Set to 1 for fastest option. Valid values are between 1 and 19. Defaults to 3.
    is_required: false