Note daemon stopping behaviour in README

Text provided by @milis92
This commit is contained in:
Daz DeBoer 2022-06-22 16:52:00 -06:00
parent fecf3693b5
commit 32923891b5
No known key found for this signature in database
GPG Key ID: DD6B9F0B06683D5D

View File

@ -205,7 +205,6 @@ Caching is enabled by default. You can disable caching for the action as follows
```yaml
cache-disabled: true
```
### Cache keys
Distributions downloaded to satisfy a `gradle-version` parameter are stored outside of Gradle User Home and cached separately. The cache key is unique to the downloaded distribution and will not change over time.
@ -234,6 +233,13 @@ You can configure read-only caching for the `gradle-build-action` as follows:
cache-read-only: ${{ github.ref != 'refs/heads/main' && github.ref != 'refs/heads/release' }}
```
### Stopping the Gradle daemon
By default, the action will stop all running Gradle daemons in the post-action step, prior to saving the Gradle User Home state.
This allows for any Gradle User Home cleanup to occur, and avoid file-locking issues on Windows.
If caching is unavailable or the cache is in read-only mode, the daemon will not be stopped and will continue running after the job is completed.
### Gradle User Home cache tuning
As well as any wrapper distributions, the action will attempt to save and restore the `caches` and `notifications` directories from Gradle User Home.