mirror of
https://github.com/gradle/actions.git
synced 2026-09-10 19:28:33 +08:00
This PR reports the support status of every Gradle version used in a workflow: - **End-of-life** — two or more major versions behind the latest release. - **Out of date** — one major version behind the latest release, or more than two minor versions behind on the current major. The information is surfaced as job annotations and in the Job Summary: an icon beside the Gradle version in the build results table, and a message below it. | version kind | job annotation | version table | below the table | | ------ | ----- | ---- | --------- | | EOL | warning | ⚠️ | expandable section, pointing to the Gradle Security Subscription | | Out of date | notice | ℹ️ | one-line legend, pointing to the Gradle release lifecycle docs | | Current | none | — | — | A single expandable section covers every end-of-life version, naming them in its summary line and listing the affected release lines in its body. The upgrade legend likewise appears once per job, however many versions carry the info icon. Notes on what is deliberately *not* reported: - **Patch releases.** Only the major and minor version are considered, so being on `9.7.0` when `9.7.1` exists is not flagged. - **Pre-releases.** Release candidates, milestones and snapshots are never reported, so testing against a nightly or an RC produces no annotations. The latest Gradle release is determined from the wrapper checksum data already bundled with the action, so no network access is required. That data is refreshed weekly, and the two-minor grace band absorbs the lag. Note that the annotations are emitted independently of `add-job-summary`: setting it to `never` suppresses the Job Summary itself, but the warning and notice annotations remain. ### Examples The `demo-job-summary` workflow has a `support-status-eol-and-outdated` job that builds with three end-of-life versions (`6.9.4`, `7.4`, `7.6.6`), two out-of-date versions (`8.0.2`, `8.14.5`) and the current release, so all three statuses appear in one summary: * **Job Summary**: https://github.com/gradle/actions/actions/runs/34166688755#summary-101879071306 * **Annotations**: https://github.com/gradle/actions/actions/runs/34166688755/job/101879071306 (expand annotations) That workflow is never triggered automatically; run it manually against a branch to review the rendering. ### Implementation * Adds `GradleVersion`, parsing and ordering versions the same way Gradle's own `org.gradle.util.GradleVersion` does. This replaces the previous `versionIsAtLeast` helper and removes the `semver` dependency. * Adds `gradle-support-status.ts`, which owns the classification policy and both of its presentations (annotations and Job Summary section) behind a three-function API, so `job-summary.ts` only asks for the icon and the rendered block. ### Testing * Unit tests for version ordering, classification, the annotations and the rendered summary. * `integ-test-gradle-support-status.yml`, which derives its expected versions from the bundled release data so the assertions cannot drift from the action's own view, then asserts against the real job log. * The demo workflow job linked above, for reviewing the rendering by eye. Documented under [Build reporting](https://github.com/gradle/actions/blob/main/docs/setup-gradle.md#gradle-version-support-status) in `docs/setup-gradle.md`. --------- Co-authored-by: Louis Jacomet <louis@gradle.com> Co-authored-by: Daz DeBoer <daz@gradle.com> Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
276 lines
9.0 KiB
YAML
276 lines
9.0 KiB
YAML
name: Demo Job Summary, for Gradle builds
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
build-distribution:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout sources
|
|
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
- name: Build and upload distribution
|
|
uses: ./.github/actions/build-dist
|
|
|
|
many-gradle-builds:
|
|
needs: build-distribution
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout sources
|
|
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
- name: Initialize integ-test
|
|
uses: ./.github/actions/init-integ-test
|
|
|
|
- name: Setup Gradle
|
|
uses: ./setup-gradle
|
|
with:
|
|
cache-read-only: false
|
|
cache-cleanup: 'on-success'
|
|
- name: Build kotlin-dsl project
|
|
working-directory: .github/workflow-samples/kotlin-dsl
|
|
run: ./gradlew assemble
|
|
- name: Build kotlin-dsl project without Build Scan®
|
|
working-directory: .github/workflow-samples/kotlin-dsl
|
|
run: ./gradlew assemble check --no-scan
|
|
- name: Build kotlin-dsl project with Build Scan® publish failure
|
|
working-directory: .github/workflow-samples/kotlin-dsl
|
|
run: ./gradlew check -Dgradle.enterprise.url=https://not.valid.server
|
|
- name: Build groovy-dsl project
|
|
working-directory: .github/workflow-samples/groovy-dsl
|
|
run: ./gradlew assemble
|
|
- name: Build kotlin-dsl project with multiple gradle invocations
|
|
working-directory: .github/workflow-samples/kotlin-dsl
|
|
run: |
|
|
./gradlew tasks --no-daemon
|
|
./gradlew help check
|
|
./gradlew :wrapper --gradle-version 8.7 --gradle-distribution-sha256-sum 544c35d6bd849ae8a5ed0bcea39ba677dc40f49df7d1835561582da2009b961d
|
|
- name: Fail groovy-dsl project
|
|
working-directory: .github/workflow-samples/groovy-dsl
|
|
continue-on-error: true
|
|
run: ./gradlew not-a-real-task
|
|
- name: Dependency submission
|
|
uses: ./dependency-submission
|
|
with:
|
|
build-root-directory: .github/workflow-samples/groovy-dsl
|
|
dependency-graph: generate-and-upload
|
|
|
|
# Exercises every Gradle version support status in a single Job Summary: end-of-life versions all
|
|
# share one expandable section and are each marked with a warning sign, out-of-date versions share
|
|
# a single info sign and legend, and the current version is left unmarked.
|
|
# Three end-of-life versions and two out-of-date ones exercise the plural wording throughout, and
|
|
# the two 7.x versions alongside a 6.x one check that each affected release line is named once,
|
|
# as "Gradle 6.x and 7.x releases".
|
|
# Versions are picked relative to Gradle 9.x being current; revisit once Gradle 10 is released.
|
|
support-status-eol-and-outdated:
|
|
needs: build-distribution
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout sources
|
|
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
# Java 11, since Gradle 6.x cannot run on the Java 17 used elsewhere in this workflow.
|
|
- name: Initialize integ-test
|
|
uses: ./.github/actions/init-integ-test
|
|
with:
|
|
java-version: '11'
|
|
|
|
- name: Setup Gradle 6.9.4 (end-of-life)
|
|
uses: ./setup-gradle
|
|
with:
|
|
gradle-version: '6.9.4'
|
|
- name: Build with Gradle 6.9.4
|
|
working-directory: .github/workflow-samples/no-wrapper
|
|
run: gradle help
|
|
|
|
- name: Setup Gradle 7.4 (end-of-life)
|
|
uses: ./setup-gradle
|
|
with:
|
|
gradle-version: '7.4'
|
|
- name: Build with Gradle 7.4
|
|
working-directory: .github/workflow-samples/no-wrapper
|
|
run: gradle help
|
|
|
|
- name: Setup Gradle 7.6.6 (end-of-life)
|
|
uses: ./setup-gradle
|
|
with:
|
|
gradle-version: '7.6.6'
|
|
- name: Build with Gradle 7.6.6
|
|
working-directory: .github/workflow-samples/no-wrapper
|
|
run: gradle help
|
|
|
|
- name: Setup Gradle 8.0.2 (out of date)
|
|
uses: ./setup-gradle
|
|
with:
|
|
gradle-version: '8.0.2'
|
|
- name: Build with Gradle 8.0.2
|
|
working-directory: .github/workflow-samples/no-wrapper
|
|
run: gradle help
|
|
|
|
- name: Setup Gradle 8.14.5 (out of date)
|
|
uses: ./setup-gradle
|
|
with:
|
|
gradle-version: '8.14.5'
|
|
- name: Build with Gradle 8.14.5
|
|
working-directory: .github/workflow-samples/no-wrapper
|
|
run: gradle help
|
|
|
|
# Gradle 9 and later require Java 17
|
|
- name: Setup Java 17
|
|
uses: actions/setup-java@b6effb05e454b25005698d916606bdc6ffcbf961 # v5.7.0
|
|
with:
|
|
distribution: temurin
|
|
java-version: 17
|
|
- name: Setup Gradle current (no status reported)
|
|
uses: ./setup-gradle
|
|
with:
|
|
gradle-version: current
|
|
- name: Build with the current Gradle version
|
|
working-directory: .github/workflow-samples/no-wrapper
|
|
run: gradle help
|
|
|
|
successful-builds-with-no-summary:
|
|
needs: build-distribution
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout sources
|
|
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
- name: Initialize integ-test
|
|
uses: ./.github/actions/init-integ-test
|
|
|
|
- name: Setup Gradle
|
|
uses: ./setup-gradle
|
|
with:
|
|
add-job-summary: on-failure
|
|
- name: Build kotlin-dsl project
|
|
working-directory: .github/workflow-samples/kotlin-dsl
|
|
run: ./gradlew assemble
|
|
- name: Build kotlin-dsl project without Build Scan®
|
|
working-directory: .github/workflow-samples/kotlin-dsl
|
|
run: ./gradlew assemble check --no-scan
|
|
|
|
pre-existing-gradle-home:
|
|
needs: build-distribution
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout sources
|
|
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
- name: Initialize integ-test
|
|
uses: ./.github/actions/init-integ-test
|
|
|
|
- name: Pre-create Gradle User Home
|
|
shell: bash
|
|
run: |
|
|
mkdir ~/.gradle
|
|
mkdir ~/.gradle/caches
|
|
touch ~/.gradle/caches/dummy.txt
|
|
- name: Setup Gradle
|
|
uses: ./setup-gradle
|
|
- name: Run build
|
|
working-directory: .github/workflow-samples/groovy-dsl
|
|
run: ./gradlew assemble
|
|
|
|
cache-read-only:
|
|
needs: build-distribution
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout sources
|
|
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
- name: Initialize integ-test
|
|
uses: ./.github/actions/init-integ-test
|
|
|
|
- name: Setup Gradle
|
|
uses: ./setup-gradle
|
|
with:
|
|
cache-read-only: true
|
|
- name: Build kotlin-dsl project
|
|
working-directory: .github/workflow-samples/kotlin-dsl
|
|
run: ./gradlew assemble
|
|
|
|
cache-disabled:
|
|
needs: build-distribution
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout sources
|
|
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
- name: Initialize integ-test
|
|
uses: ./.github/actions/init-integ-test
|
|
|
|
- name: Setup Gradle
|
|
uses: ./setup-gradle
|
|
with:
|
|
cache-disabled: true
|
|
- name: Build kotlin-dsl project
|
|
working-directory: .github/workflow-samples/kotlin-dsl
|
|
run: ./gradlew assemble
|
|
|
|
cache-provider-external:
|
|
needs: build-distribution
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout sources
|
|
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
- name: Initialize integ-test
|
|
uses: ./.github/actions/init-integ-test
|
|
|
|
- name: Setup Gradle
|
|
uses: ./setup-gradle
|
|
with:
|
|
cache-provider: external
|
|
- name: Build kotlin-dsl project
|
|
working-directory: .github/workflow-samples/kotlin-dsl
|
|
run: ./gradlew assemble
|
|
|
|
basic-caching:
|
|
needs: build-distribution
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout sources
|
|
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
- name: Initialize integ-test
|
|
uses: ./.github/actions/init-integ-test
|
|
|
|
- name: Setup Gradle
|
|
uses: ./setup-gradle
|
|
with:
|
|
cache-provider: basic
|
|
- name: Build kotlin-dsl project
|
|
working-directory: .github/workflow-samples/kotlin-dsl
|
|
run: ./gradlew assemble
|
|
|
|
terms-of-use-accepted:
|
|
needs: build-distribution
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout sources
|
|
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
- name: Initialize integ-test
|
|
uses: ./.github/actions/init-integ-test
|
|
|
|
- name: Setup Gradle
|
|
uses: ./setup-gradle
|
|
with:
|
|
build-scan-terms-of-use-url: https://gradle.com/help/legal-terms-of-use
|
|
build-scan-terms-of-use-agree: yes
|
|
- name: Build kotlin-dsl project
|
|
working-directory: .github/workflow-samples/kotlin-dsl
|
|
run: ./gradlew assemble
|
|
|
|
develocity-access-key-set:
|
|
needs: build-distribution
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout sources
|
|
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
|
- name: Initialize integ-test
|
|
uses: ./.github/actions/init-integ-test
|
|
|
|
- name: Setup Gradle
|
|
uses: ./setup-gradle
|
|
with:
|
|
develocity-access-key: ${{ secrets.DV_SOLUTIONS_ACCESS_KEY }}
|
|
- name: Build kotlin-dsl project
|
|
working-directory: .github/workflow-samples/kotlin-dsl
|
|
run: ./gradlew assemble
|