From 5423935c9b0cb2cc51e42e9cee96a1047a3de8c0 Mon Sep 17 00:00:00 2001 From: Daz DeBoer Date: Wed, 7 Jul 2021 12:45:24 -0600 Subject: [PATCH] Deprecate the 'wrapper-directory' input and recommend 'gradle-executable' instead Use of a wrapper in a non-standard directory is uncommon, and is effectively handled by referencing the `gradlew` script as the `gradle-executable`. --- .github/workflows/prod.yml | 12 ++++++------ README.md | 18 ++++++++++-------- action.yml | 1 + 3 files changed, 17 insertions(+), 14 deletions(-) diff --git a/.github/workflows/prod.yml b/.github/workflows/prod.yml index efe493e..006a576 100644 --- a/.github/workflows/prod.yml +++ b/.github/workflows/prod.yml @@ -22,12 +22,6 @@ jobs: with: build-root-directory: __tests__/samples/basic arguments: test - - name: Test custom wrapper location - uses: ./ - with: - build-root-directory: __tests__/samples/no-wrapper - wrapper-directory: __tests__/samples/basic - arguments: help - name: Test use defined Gradle version uses: ./ with: @@ -46,6 +40,12 @@ jobs: gradle-executable: __tests__/samples/basic/gradlew${{ matrix.script-suffix }} build-root-directory: __tests__/samples/no-wrapper arguments: help + - name: Test custom wrapper location (deprecated) + uses: ./ + with: + build-root-directory: __tests__/samples/no-wrapper + wrapper-directory: __tests__/samples/basic + arguments: help failures: # These build invocations are informational only, and are expected to fail runs-on: ubuntu-latest diff --git a/README.md b/README.md index cd027f1..f954ac1 100644 --- a/README.md +++ b/README.md @@ -60,14 +60,6 @@ If you need to pass environment variables, simply use the GitHub Actions workflo build-root-directory: some/subdirectory ``` -## Use a Gradle wrapper from a different directory - -```yaml - - uses: eskatos/gradle-command-action@v1 - with: - wrapper-directory: path/to/wrapper-directory - ``` - ## Use a specific `gradle` executable ```yaml @@ -76,6 +68,16 @@ If you need to pass environment variables, simply use the GitHub Actions workflo gradle-executable: path/to/gradle ``` +## Use a Gradle wrapper from a different directory + +```yaml + - uses: eskatos/gradle-command-action@v1 + with: + gradle-executable: path/to/gradlew + ``` + + NOTE: The `wrapper-directory` input has been deprecated. Use `gradle-executable` instead. + ## Setup and use a declared Gradle version ```yaml diff --git a/action.yml b/action.yml index 85608f8..904ee90 100644 --- a/action.yml +++ b/action.yml @@ -8,6 +8,7 @@ inputs: wrapper-directory: description: Path to the Gradle Wrapper directory required: false + deprecationMessage: Use 'gradle-executable' to point to a gradlew[.bat] file in a non-default location gradle-executable: description: Path to the Gradle executable required: false