Skip to content

Commit

Permalink
Minor update to setup-gradle README
Browse files Browse the repository at this point in the history
  • Loading branch information
bigdaz authored Jan 26, 2024
1 parent f218f2e commit b6816cf
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions setup-gradle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@ However, the `setup-gradle` action offers a number of advantages over this appro
The `setup-gradle` action is designed to provide these benefits with minimal configuration.
These features work both when Gradle is executed via `setup-gradle` and for any Gradle execution in subsequent steps.

## Use the action to setup Gradle

The recommended way to use `setup-gradle` is in an initial "Setup Gradle" step, with subsequent steps invoking Gradle directly with a `run` step. This makes the action minimally invasive, and allows a workflow to configure and execute a Gradle execution in any way.
## General usage

The `setup-gradle` action works by configuring environment variables and by adding a set of Gradle init-scripts to the Gradle User Home. These will apply to all Gradle executions on the runner, no matter how Gradle is invoked.
This means that if you have an existing workflow that executes Gradle with a `run` step, you can add an initial "Setup Gradle" Step to benefit from caching, build-scan capture and other features of this action.
Expand Down

0 comments on commit b6816cf

Please # to comment.