diff --git a/README.md b/README.md index fef3200..9eb8b0b 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,9 @@ > > See the [setup-gradle documentation](https://github.com/gradle/actions/tree/main/setup-gradle) for up-to-date documentation for `gradle/actions/setup-gradle`. -# Setup Gradle for use in GitHub Actions workflows +# Execute Gradle builds in GitHub Actions workflows -This GitHub Action can be used to configure Gradle on any platform supported by GitHub Actions. +This GitHub Action can be used to configure Gradle and optionally execute a Gradle build on any platform supported by GitHub Actions. ## Example usage @@ -32,9 +32,12 @@ jobs: - name: Checkout sources uses: actions/checkout@v4 - name: Setup Gradle - uses: gradle/actions/setup-gradle@v3 + uses: gradle/gradle-build-action@v3 - name: Build with Gradle run: ./gradlew build ``` +As of `v3`, the `gradle/gradle-build-action` action delegates to `gradle/actions/setup-gradle` with the same version. +Configuration and usage of these actions is identical for releases with the same version number. + See the [full setup-gradle documentation](https://github.com/gradle/actions/tree/main/setup-gradle) for more advanced usage scenarios. diff --git a/action.yml b/action.yml index 1278f1b..ca67a1f 100644 --- a/action.yml +++ b/action.yml @@ -1,4 +1,4 @@ -name: setup-gradle +name: "Gradle Build Action" description: 'Configures Gradle for GitHub actions, caching state and generating a dependency graph via Dependency Submission.' inputs: