From c12283ec5739060a94e0871431e1ae7dc1e16f0c Mon Sep 17 00:00:00 2001 From: Daz DeBoer Date: Mon, 1 Nov 2021 12:35:15 -0600 Subject: [PATCH] Add a section explaining advantages --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 44ab79d..7c94dd4 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,19 @@ Each invocation will start its run with the filesystem state remaining from the arguments: check ``` +### Why is this better than running Gradle directly? + +It is possible to directly invoke Gradle in your workflow, and the `setup-java` action provides a simple way to cache Gradle dependencies. + +However, the `gradle-build-action` offers a number of advantages over this approach: + +- Easily [run the build with different versions of Gradle](#download-install-and-use-a-specific-gradle-version) using the `gradle-version` parameter. Gradle distributions are automatically downloaded and cached. +- More sophisticated and more efficient caching of Gradle User Home between invocations, compared to `setup-java` and most custom configurations using `actions/cache`. [More details below](#caching). +- Detailed reporting of cache usage and cache configuration options allow you to [optimize the use of the GitHub actions cache](#optimizing-cache-effectiveness). +- [Automatic capture of build scan links](#build-scans) from the build, making these easier to locate for workflow run. + +The `gradle-build-action` is designed to provide these benefits with minimal configuration. + ## Gradle Execution ### Command-line arguments