gradle/gradle-build-action
1
0
Fork 0
mirror of https://github.com/gradle/gradle-build-action.git synced 2025-04-06 13:24:13 +02:00
Code Issues Projects Releases Packages Wiki Activity

README improvements

Browse source 
Upgrade checkout to v3.
setup-java:
 Upgrade to v3.
 Always specify distribution.
upload-artifact:
 Upgrade to v3.
 Add if-no-files-found: error.
Upgrade github-script to v6.
Formatting.
This commit is contained in:
Margen67 2022-05-18 17:14:21 -07:00
parent 557c94c831
commit 71d0cf002c
1 changed files with 79 additions and 77 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

156
README.md
View file

@ -19,34 +19,33 @@ jobs:
os: [ubuntu-latest, macos-latest, windows-latest] os: [ubuntu-latest, macos-latest, windows-latest]
runs-on: ${{ matrix.os }} runs-on: ${{ matrix.os }}
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- uses: actions/setup-java@v2 - uses: actions/setup-java@v3
with: with:
distribution: temurin distribution: temurin
java-version: 11 java-version: 11
- name: Setup Gradle - name: Setup Gradle
uses: gradle/gradle-build-action@v2 uses: gradle/gradle-build-action@v2
- name: Execute Gradle build - name: Execute Gradle build
run: ./gradlew build run: ./gradlew build
``` ```
## Why use the `gradle-build-action`? ## Why use the `gradle-build-action`?
It is possible to directly invoke Gradle in your workflow, and the `actions/setup-java@v2` action provides a simple way to cache Gradle dependencies. It is possible to directly invoke Gradle in your workflow, and the `actions/setup-java@v3` action provides a simple way to cache Gradle dependencies.
However, the `gradle-build-action` offers a number of advantages over this approach: However, the `gradle-build-action` offers a number of advantages over this approach:
- Easily [run the build with different versions of Gradle](#download-install-and-use-a-specific-gradle-version) using the `gradle-version` parameter. Gradle distributions are automatically downloaded and cached.
- Easily [run the build with different versions of Gradle](#download-install-and-use-a-specific-gradle-version) using the `gradle-version` parameter. Gradle distributions are automatically downloaded and cached.
- More sophisticated and more efficient caching of Gradle User Home between invocations, compared to `setup-java` and most custom configurations using `actions/cache`. [More details below](#caching). - More sophisticated and more efficient caching of Gradle User Home between invocations, compared to `setup-java` and most custom configurations using `actions/cache`. [More details below](#caching).
- Detailed reporting of cache usage and cache configuration options allow you to [optimize the use of the GitHub actions cache](#optimizing-cache-effectiveness). - Detailed reporting of cache usage and cache configuration options allow you to [optimize the use of the GitHub actions cache](#optimizing-cache-effectiveness).
- [Automatic capture of build scan links](#build-scans) from the build, making these easier to locate for workflow run. - [Automatic capture of build scan links](#build-scans) from the build, making these easier to locate for workflow run.
The `gradle-build-action` is designed to provide these benefits with minimal configuration. The `gradle-build-action` is designed to provide these benefits with minimal configuration.
These features work both when Gradle is executed via the `gradle-build-action` and for any Gradle execution in subsequent steps. These features work both when Gradle is executed via the `gradle-build-action` and for any Gradle execution in subsequent steps.
When using `gradle-build-action` we recommend that you _not_ use `actions/cache` or `actions/setup-java@v2` to explicitly cache the Gradle User Home. Doing so may interfere with the caching provided by this action. When using `gradle-build-action` we recommend that you _not_ use `actions/cache` or `actions/setup-java@v3` to explicitly cache the Gradle User Home. Doing so may interfere with the caching provided by this action.
## Use a specific Gradle version ## Use a specific Gradle version
@ -63,13 +62,13 @@ The `gradle-version` parameter can be set to any valid Gradle version.
Moreover, you can use the following aliases: Moreover, you can use the following aliases:
| Alias | Selects | | Alias | Selects |
| --- |---| | --- | --- |
| `wrapper` | The Gradle wrapper's version (default, useful for matrix builds) | | `wrapper` | The Gradle wrapper's version (default, useful for matrix builds) |
| `current` | The current [stable release](https://gradle.org/install/) | | `current` | The current [stable release](https://gradle.org/install/) |
| `release-candidate` | The current [release candidate](https://gradle.org/release-candidate/) if any, otherwise fallback to `current` | | `release-candidate` | The current [release candidate](https://gradle.org/release-candidate/) if any, otherwise fallback to `current` |
| `nightly` | The latest [nightly](https://gradle.org/nightly/), fails if none. | | `nightly` | The latest [nightly](https://gradle.org/nightly/), fails if none. |
| `release-nightly` | The latest [release nightly](https://gradle.org/release-nightly/), fails if none. | | `release-nightly` | The latest [release nightly](https://gradle.org/release-nightly/), fails if none. |
This can be handy to automatically verify your build works with the latest release candidate of Gradle: This can be handy to automatically verify your build works with the latest release candidate of Gradle:
@ -77,19 +76,20 @@ This can be handy to automatically verify your build works with the latest relea
name: Test latest Gradle RC name: Test latest Gradle RC
on: on:
schedule: schedule:
- cron: 0 0 * * * # daily - cron: '0 0 * * *' # daily
jobs: jobs:
gradle-rc: gradle-rc:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- uses: actions/setup-java@v2 - uses: actions/setup-java@v3
with: with:
java-version: 11 distribution: temurin
- uses: gradle/gradle-build-action@v2 java-version: 11
with: - uses: gradle/gradle-build-action@v2
gradle-version: release-candidate with:
- run: gradle build --dry-run # just test build configuration gradle-version: release-candidate
- run: gradle build --dry-run # just test build configuration
``` ```
## Gradle Execution ## Gradle Execution
@ -108,15 +108,16 @@ jobs:
os: [ubuntu-latest, macos-latest, windows-latest] os: [ubuntu-latest, macos-latest, windows-latest]
runs-on: ${{ matrix.os }} runs-on: ${{ matrix.os }}
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- uses: actions/setup-java@v2 - uses: actions/setup-java@v3
with: with:
java-version: 11 distribution: temurin
java-version: 11
- name: Setup and execute Gradle 'test' task
uses: gradle/gradle-build-action@v2 - name: Setup and execute Gradle 'test' task
with: uses: gradle/gradle-build-action@v2
arguments: test with:
arguments: test
``` ```
### Multiple Gradle executions in the same Job ### Multiple Gradle executions in the same Job
@ -145,10 +146,10 @@ arguments: check --scan
arguments: some arbitrary tasks arguments: some arbitrary tasks
arguments: build -PgradleProperty=foo arguments: build -PgradleProperty=foo
arguments: | arguments: |
build build
--scan --scan
-PgradleProperty=foo -PgradleProperty=foo
-DsystemProperty=bar -DsystemProperty=bar
``` ```
If you need to pass environment variables, use the GitHub Actions workflow syntax: If you need to pass environment variables, use the GitHub Actions workflow syntax:
@ -190,7 +191,7 @@ This mechanism can also be used to target a Gradle wrapper script that is locate
## Caching ## Caching
By default, this action aims to cache any and all reusable state that may be speed up a subsequent build invocation. By default, this action aims to cache any and all reusable state that may be speed up a subsequent build invocation.
The state that is cached includes: The state that is cached includes:
- Any distributions downloaded to satisfy a `gradle-version` parameter ; - Any distributions downloaded to satisfy a `gradle-version` parameter ;
@ -238,12 +239,12 @@ The contents to be cached can be fine tuned by including and excluding certain p
```yaml ```yaml
# Cache downloaded JDKs in addition to the default directories. # Cache downloaded JDKs in addition to the default directories.
gradle-home-cache-includes: | gradle-home-cache-includes: |
caches caches
notifications notifications
jdks jdks
# Exclude the local build-cache from the directories cached. # Exclude the local build-cache from the directories cached.
gradle-home-cache-excludes: | gradle-home-cache-excludes: |
caches/build-cache-1 caches/build-cache-1
``` ```
You can specify any number of fixed paths or patterns to include or exclude. You can specify any number of fixed paths or patterns to include or exclude.
@ -297,21 +298,22 @@ To save selected files from your build execution, you can use the core [Upload-A
For example: For example:
```yaml ```yaml
jobs: jobs:
gradle: gradle:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout project sources - name: Checkout project sources
uses: actions/checkout@v2 uses: actions/checkout@v3
- name: Setup Gradle - name: Setup Gradle
uses: gradle/gradle-build-action@v2 uses: gradle/gradle-build-action@v2
- name: Run build with Gradle wrapper - name: Run build with Gradle wrapper
run: ./gradlew build --scan run: ./gradlew build --scan
- name: Upload build reports - name: Upload build reports
uses: actions/upload-artifact@v3 uses: actions/upload-artifact@v3
with: with:
name: build-reports name: build-reports
path: build/reports/ path: build/reports
if-no-files-found: error
``` ```
## Build scans ## Build scans
@ -330,23 +332,23 @@ jobs:
gradle: gradle:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Checkout project sources - name: Checkout project sources
uses: actions/checkout@v2 uses: actions/checkout@v3
- name: Setup Gradle - name: Setup Gradle
uses: gradle/gradle-build-action@v2 uses: gradle/gradle-build-action@v2
- name: Run build with Gradle wrapper - name: Run build with Gradle wrapper
id: gradle id: gradle
run: ./gradlew build --scan run: ./gradlew build --scan
- name: "Add build scan URL as PR comment" - name: Add build scan URL as PR comment
uses: actions/github-script@v5 uses: actions/github-script@v6
if: github.event_name == 'pull_request' && failure() if: github.event_name == 'pull_request' && failure()
with: with:
github-token: ${{secrets.GITHUB_TOKEN}} github-token: ${{ secrets.GITHUB_TOKEN }}
script: | script: |
github.rest.issues.createComment({ github.rest.issues.createComment({
issue_number: context.issue.number, issue_number: context.issue.number,
owner: context.repo.owner, owner: context.repo.owner,
repo: context.repo.repo, repo: context.repo.repo,
body: '❌ ${{ github.workflow }} failed: ${{ steps.gradle.outputs.build-scan-url }}' body: '❌ ${{ github.workflow }} failed: ${{ steps.gradle.outputs.build-scan-url }}'
}) })
``` ```