-
Notifications
You must be signed in to change notification settings - Fork 84
Open
Description
Please clarify in the action.yml file which cache- inputs affect which caches.
actions/setup-gradle/action.yml
Lines 11 to 66 in 182e4d3
| # Cache configuration | |
| cache-disabled: | |
| description: When 'true', all caching is disabled. No entries will be written to or read from the cache. | |
| required: false | |
| default: false | |
| cache-read-only: | |
| description: | | |
| When 'true', existing entries will be read from the cache but no entries will be written. | |
| By default this value is 'false' for workflows on the GitHub default branch and 'true' for workflows on other branches. | |
| required: false | |
| default: ${{ github.event.repository != null && github.ref_name != github.event.repository.default_branch }} | |
| cache-write-only: | |
| description: | | |
| When 'true', entries will not be restored from the cache but will be saved at the end of the Job. | |
| Setting this to 'true' implies cache-read-only will be 'false'. | |
| required: false | |
| default: false | |
| cache-overwrite-existing: | |
| description: When 'true', a pre-existing Gradle User Home will not prevent the cache from being restored. | |
| required: false | |
| default: false | |
| cache-encryption-key: | |
| description: | | |
| A base64 encoded AES key used to encrypt the configuration-cache data. The key is exported as 'GRADLE_ENCRYPTION_KEY' for later steps. | |
| A suitable key can be generated with `openssl rand -base64 16`. | |
| Configuration-cache data will not be saved/restored without an encryption key being provided. | |
| required: false | |
| cache-cleanup: | |
| description: | | |
| Specifies if the action should attempt to remove any stale/unused entries from the Gradle User Home prior to saving to the GitHub Actions cache. | |
| By default ('on-success'), cleanup is performed when all Gradle builds succeed for the Job. | |
| This behaviour can be disabled ('never'), or configured to always run irrespective of the build outcome ('always'). | |
| Valid values are 'never', 'on-success' and 'always'. | |
| required: false | |
| default: 'on-success' | |
| gradle-home-cache-cleanup: | |
| description: When 'true', the action will attempt to remove any stale/unused entries from the Gradle User Home prior to saving to the GitHub Actions cache. | |
| required: false | |
| deprecation-message: This input has been superceded by the 'cache-cleanup' input parameter. | |
| gradle-home-cache-includes: | |
| description: Paths within Gradle User Home to cache. | |
| required: false | |
| default: | | |
| caches | |
| notifications | |
| gradle-home-cache-excludes: | |
| description: Paths within Gradle User Home to exclude from cache. | |
| required: false |
The available caches being:
- GitHub Actions Cache
- Build Cache
- Configuration Cache
- Artifact Transforms?
- maybe more?
For example we have been wondering if cache-read-only: affects GHA and CC.
https://docs.gradle.org/current/userguide/configuration_cache_enabling.html#config_cache:usage:read_only
It could be argued both ways that setup-gradle should/not set the CC read-only flag on PRs.
This issue about clarifying what is intended, not whether it should or not.
grimsa-aurorasolar, adriantr, AiAutomationAgency and BeniwasabiKarashi
Metadata
Metadata
Assignees
Labels
No labels