mirror of
https://github.com/gradle/gradle-build-action.git
synced 2024-11-22 09:02:50 +00:00
Document the cache-overwrite-existing parameter
This commit is contained in:
parent
b946c060aa
commit
b156d58cac
1 changed files with 14 additions and 0 deletions
14
README.md
14
README.md
|
@ -145,6 +145,20 @@ In certain circumstances it may be desirable to start with a clean Gradle User H
|
||||||
cache-write-only: true
|
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
|
### 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.
|
When using `gradle-build-action` we recommend that you avoid using other mechanisms to save and restore the Gradle User Home.
|
||||||
|
|
Loading…
Reference in a new issue