From 32923891b5a93a4766168f1ba1c0ac9871ea5537 Mon Sep 17 00:00:00 2001 From: Daz DeBoer Date: Wed, 22 Jun 2022 16:52:00 -0600 Subject: [PATCH] Note daemon stopping behaviour in README Text provided by @milis92 --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index eeab134..5ea03c3 100644 --- a/README.md +++ b/README.md @@ -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.