gradle/actions
1
0
Fork 0
mirror of https://github.com/gradle/actions synced 2024-11-24 02:12:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Document the cache-overwrite-existing parameter

Browse source
This commit is contained in:
Daz DeBoer 2023-08-20 14:14:54 -06:00 committed by GitHub
parent b946c060aa
commit b156d58cac
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -145,6 +145,20 @@ In certain circumstances it may be desirable to start with a clean Gradle User H
cache-write-only: true
```
### Overwriting an existing Gradle User Home
When the action detects that the Gradle User Home caches directory already exists (`~/.gradle/caches`), then by default it will not overwrite the existing content of this directory.
This can occur when a prior action initializes this directory, or when using a self-hosted runner that retains this directory between uses.
In this case the Job Summary will display a message like:
> Caching for gradle-build-action was disabled due to pre-existing Gradle User Home
If you want override the default and have the `gradle-build-action` caches overwrite existing content in the Gradle User Home, you can set the `cache-overwrite-existing` parameter to 'true':
```yaml
cache-overwrite-existing: true
```
### Incompatibility with other caching mechanisms
When using `gradle-build-action` we recommend that you avoid using other mechanisms to save and restore the Gradle User Home.