mirror of
https://github.com/gradle/actions
synced 2024-11-27 20:02:19 +00:00
d211a39090
* Use consistent YAML syntax in example workflows * Add link to plugin env vars
34 lines
1.1 KiB
Markdown
34 lines
1.1 KiB
Markdown
## The `setup-gradle` action
|
|
|
|
The `setup-gradle` action can be used to configure Gradle for optimal execution on any platform supported by GitHub Actions.
|
|
|
|
This replaces the previous `gradle/gradle-build-action`, which now delegates to this implementation.
|
|
|
|
The recommended way to execute any Gradle build is with the help of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html), and the examples assume that the Gradle Wrapper has been configured for the project. See [this example](../docs/setup-gradle.md#build-with-a-specific-gradle-version) if your project doesn't use the Gradle Wrapper.
|
|
|
|
### Example usage
|
|
|
|
```yaml
|
|
name: Build
|
|
|
|
on:
|
|
push:
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout sources
|
|
uses: actions/checkout@v4
|
|
- name: Setup Java
|
|
uses: actions/setup-java@v4
|
|
with:
|
|
distribution: 'temurin'
|
|
java-version: 17
|
|
- name: Setup Gradle
|
|
uses: gradle/actions/setup-gradle@v3
|
|
- name: Build with Gradle
|
|
run: ./gradlew build
|
|
```
|
|
|
|
See the [full action documentation](../docs/setup-gradle.md) for more advanced usage scenarios.
|