step.yml

title: Save Gradle configuration cache
summary: Caches the Gradle configuration cache folder used by Gradle. Uses the Bitrise Build Cache infrastructure.
description: |
    This step caches the Gradle configuration cache folder along with the necessary metadata to speed up future builds. The cache is stored within the Bitrise Build Cache infrastructure.

    For more information on how configuration caching works, refer to the [Gradle user guide](https://docs.gradle.org/current/userguide/configuration_cache.html).

    Unless specified otherwise, the current directory is assumed to be the project directory, and therefore the `./gradle/configuration-cache` directory will be saved.

    **IMPORTANT NOTES:**
    - You must have an active Bitrise Build Cache Trial or Subscription for your workspace to use this step.
    - You also need to set up the encryption key `GRADLE_ENCRYPTION_KEY` in Bitrise Secrets by using the result from running `openssl rand -base64 16`.
    - Setting the encryption key is supported only from Gradle version 8.6 onwards, so your project must be using Gradle 8.6 or higher.
website: https://github.com/bitrise-steplib/bitrise-step-save-gradle-configuration-cache
source_code_url: https://github.com/bitrise-steplib/bitrise-step-save-gradle-configuration-cache
support_url: https://github.com/bitrise-steplib/bitrise-step-save-gradle-configuration-cache

project_type_tags:
- android
- react-native
- flutter

type_tags:
- utility

run_if: .IsCI
is_skippable: true

toolkit:
  bash:
    entry_file: step.sh

deps:
  brew:
  - name: zstd

inputs:
- key_override:
  opts:
    title: Cache key override
    summary: Override key used for saving the cache. By default the app slug and branch is used
    description: |-
      Manually provided override key used for saving the cache.

      If not specified, by default a key is generated from the app slug and the current branch. If not specified, the contents are also saved to a fallback key consisting only of the app slug. This helps reduce cache misses on new feature branches.
    is_required: false
- config_cache_dir: ./.gradle/configuration-cache
  opts:
    title: Configuration cache directory
    summary: Path to the configuration cache folder
    description: |-
      This needs to be set to the config cache folder generated by Gradle. It's usually in the project and NOT in the Gradle home.
    is_required: true

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