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`.
This commit is contained in:
Daz DeBoer 2021-07-07 12:45:24 -06:00
parent 41ca2299a5
commit 5423935c9b
No known key found for this signature in database
GPG key ID: DD6B9F0B06683D5D
3 changed files with 17 additions and 14 deletions

View file

@ -22,12 +22,6 @@ jobs:
with: with:
build-root-directory: __tests__/samples/basic build-root-directory: __tests__/samples/basic
arguments: test 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 - name: Test use defined Gradle version
uses: ./ uses: ./
with: with:
@ -46,6 +40,12 @@ jobs:
gradle-executable: __tests__/samples/basic/gradlew${{ matrix.script-suffix }} gradle-executable: __tests__/samples/basic/gradlew${{ matrix.script-suffix }}
build-root-directory: __tests__/samples/no-wrapper build-root-directory: __tests__/samples/no-wrapper
arguments: help 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 failures: # These build invocations are informational only, and are expected to fail
runs-on: ubuntu-latest runs-on: ubuntu-latest

View file

@ -60,14 +60,6 @@ If you need to pass environment variables, simply use the GitHub Actions workflo
build-root-directory: some/subdirectory 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 ## Use a specific `gradle` executable
```yaml ```yaml
@ -76,6 +68,16 @@ If you need to pass environment variables, simply use the GitHub Actions workflo
gradle-executable: path/to/gradle 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 ## Setup and use a declared Gradle version
```yaml ```yaml

View file

@ -8,6 +8,7 @@ inputs:
wrapper-directory: wrapper-directory:
description: Path to the Gradle Wrapper directory description: Path to the Gradle Wrapper directory
required: false required: false
deprecationMessage: Use 'gradle-executable' to point to a gradlew[.bat] file in a non-default location
gradle-executable: gradle-executable:
description: Path to the Gradle executable description: Path to the Gradle executable
required: false required: false