mirror of
https://github.com/gradle/gradle-build-action.git
synced 2024-11-22 00:01:05 -05:00
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:
parent
41ca2299a5
commit
5423935c9b
3 changed files with 17 additions and 14 deletions
12
.github/workflows/prod.yml
vendored
12
.github/workflows/prod.yml
vendored
|
@ -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
|
||||
|
|
18
README.md
18
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
|
||||
|
|
|
@ -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
|
||||
|
|
Loading…
Reference in a new issue