actions

This release brings some minor improvements:

• The latest release of Gradle is no longer required to perform cache-cleanup. If Gradle is found to on the PATH and the version meets minimum version requirements, then the version on PATH is used for cache-cleanup and Gradle is not downloaded.
• Fixes a bug where setting the develocity-token-expiry parameter had no effect (#381)
• Numerous NPM dependency updates

Full Changelog: https://github.com/gradle/actions/compare/v4.0.1...v4.1.0

This patch release updates a number of dependencies, and fixes a bug that caused Gradle version '8.1' to be confused with '8.10'.

What's Changed

• Dependency-updates by @bigdaz in https://github.com/gradle/actions/pull/326, https://github.com/gradle/actions/pull/356
• NPM dependency updates by @dependabot in https://github.com/gradle/actions/pull/330, https://github.com/gradle/actions/pull/349
• Include Gradle 8.10 in known wrapper checksums in https://github.com/gradle/actions/pull/341
• Differentiate Gradle 8.1 from 8.10 when checking version by @bigdaz in https://github.com/gradle/actions/pull/358

Full Changelog: https://github.com/gradle/actions/compare/v4.0.0...v4.0.1

Final release of v4.0.0 of the setup-gradle, dependency-submission and wrapper-validation actions provided under gradle/actions.
This release is available under the v4 tag.

Major changes from the v3 release

The arguments parameter has been removed

Using the action to execute Gradle via the arguments parameter was deprecated in v3 and this parameter has been removed.
See here for more details.

Cache cleanup enabled by default

After a number of fixes and improvements, this release enables cache-cleanup by default for all Jobs using the setup-gradle and dependency-submission actions.

Improvements and bugfixes related cache cleanup:

• By default, cache cleanup is not run if any Gradle build fails (#71)
• Cache cleanup is not run after configuration-cache reuse (#19)

This feature should help to minimize the size of entries written to the GitHub Actions cache, speeding up builds and reducing cache usage.

Wrapper validation enabled by default

In v3, the setup-gradle action was enhanced to support Gradle wrapper validation, removing the need to use a separate workflow
file with the gradle/actions/wrapper-validation action.

With this release, wrapper validation has been significantly improved, and is now enabled by default (#12):

• The allow-snapshot-wrappers makes it possible to validate snapshot wrapper jars using setup-gradle.
• Checksums for nightly and snapshot Gradle versions are now validated (#281).
• Valid wrapper checksums are cached in Gradle User Home, reducing the need to retrieve checksum values remotely (#172).
• Reduce network calls in wrapper-validation for new Gradle versions: By only fetching wrapper checksums for Gradle versions that were not known when this action was released, this release reduces the likelihood that a network failure could cause failure in wrapper validation (#171)
• Improved error message when wrapper-validation finds no wrapper jars (#284)

Wrapper validation is important for supply-chain integrity. Enabling this feature by default will increase the coverage of wrapper
validation on projects using GitHub Actions.

New input parameters for Dependency Graph generation

Some dependency-graph inputs that could previously only be configured via environment variables now have dedicated action inputs:

• dependency-graph-report-dir: sets the location where dependency-graph reports will be generated
• dependency-graph-exclude-projects and dependency-graph-include-projects: select which Gradle projects will contribute to the generated dependency graph.
• dependency-graph-exclude-configurations and dependency-graph-include-configurations: select which Gradle configurations will contribute to the generated dependency graph.

Other improvements

• In Job summary, the action now provides an explanation when cache is set to read-only or disabled (#255)
• When setup-gradle requests a specific Gradle version, the action will no longer download and install that version if it is already available on the PATH of the runner (#270)
• To attempt to speed up builds, the setup-gradle and dependency-submission actions now attempt to use the D: drive for Gradle User Home if it is available (#290)

Deprecations and breaking changes

• The gradle-home-cache-cleanup input parameter has been deprecated and replaced by cache-cleanup
• The undocumented dependency-graph: clear parameter has been removed without replacement
• The following parameters deprecated in v3 have been removed:
  • arguments
  • build-scan-terms-of-service-url and build-scan-terms-of-service-agree

Changelog

• Only fetch checksums for unknown wrapper versions by @bigdaz in https://github.com/gradle/actions/pull/292
• Isolate 'dependency-submission' action from 'setup-gradle' by @bigdaz in https://github.com/gradle/actions/pull/293
• Caching improvements by @bigdaz in https://github.com/gradle/actions/pull/294
• Config cache cleanup by @bigdaz in https://github.com/gradle/actions/pull/295
• Delete excluded paths on restore Gradle Home by @bigdaz in https://github.com/gradle/actions/pull/298
• Use faster D: drive on windows for Gradle User Home and Gradle downloads by @bigdaz in https://github.com/gradle/actions/pull/299
• Always set the GRADLE_USER_HOME env var by @bigdaz in https://github.com/gradle/actions/pull/300
• Fix windows by @bigdaz in https://github.com/gradle/actions/pull/302
• Use pre-installed Gradle when available by @bigdaz in https://github.com/gradle/actions/pull/301
• Prepare for v4 release by @bigdaz in https://github.com/gradle/actions/pull/303
• Include RUNNER_ARCH in cache key by @bigdaz in https://github.com/gradle/actions/pull/305
• Introduce dependency graph params by @bigdaz in https://github.com/gradle/actions/pull/304
• Finish enabling cache-cleanup by default by @bigdaz in https://github.com/gradle/actions/pull/306
• Bump references to Develocity Gradle plugin from 3.17.5 to 3.17.6 by @bot-githubaction in https://github.com/gradle/actions/pull/315
• Group cache-cleanup log messages by @bigdaz in https://github.com/gradle/actions/pull/319
• Enable wrapper-validation by default in setup-gradle by @bigdaz in https://github.com/gradle/actions/pull/318
• Improve error messages for min-wrapper-count by @bigdaz in https://github.com/gradle/actions/pull/321

Full Changelog: https://github.com/gradle/actions/compare/v3.5.0...v4.0.0

First release candidate for v4 of the setup-gradle, dependency-submission and wrapper-validation actions provided under gradle/actions. As no issues were reported, this release candidate has been promoted as v4.0.0.
This is the first release available under the v4 tag.

Full Changelog: https://github.com/gradle/actions/compare/v3.5.0...v4.0.0-rc.1

Second beta release for v4 of the setup-gradle, dependency-submission and wrapper-validation actions provided under gradle/actions.
This release (and all subsequent releases leading up to v4) will be available under the prerelease/v4 tag. eg.

uses: gradle/actions/setup-gradle@prerelease/v4

Full Changelog: https://github.com/gradle/actions/compare/v3.5.0...v4.0.0-beta.2

First beta release for v4 of the setup-gradle, dependency-submission and wrapper-validation actions provided under gradle/actions.
This release (and all subsequent releases leading up to v4) will be available under the prerelease/v4 tag. eg.

Full Changelog: https://github.com/gradle/actions/compare/v3.5.0...v4.0.0-beta.1

This release contains a major upgrade to gradle-home-cache-cleanup as well as improvements to dependency-submission.

What's Changed

• Include Gradle 8.9 in known wrapper checksums (avoiding the need to download) (#266)
• Improvements to cache-cleanup
  • Provision latest Gradle version to use for cache-cleanup (#33, #271)
  • Avoid use of timestamp manipulation for cache-cleanup (#24, #272)
  • Cleanup artifact transforms cache in Gradle home (#47)
  • More logging from cache-cleanup operation (#169)
• Use latest dependency graph plugin (#269)
  • Avoid resolving configurations that are deprecated for resolving (https://github.com/gradle/github-dependency-graph-gradle-plugin/pull/129)
  • Avoid circular task dependency when build includes itself (https://github.com/gradle/github-dependency-graph-gradle-plugin/issues/141)
• Automatically upload dependency graph file on submission failure (#291)

Full Changelog: https://github.com/gradle/actions/compare/v3.4.2...v3.5.0

This patch release fixes a race condition that resulted in the DEVELOCITY_ACCESS_KEY variable not being set in the environment.

What's Changed

• Fix race condition with fetching short lived token by @alextu in https://github.com/gradle/actions/pull/260

Full Changelog: https://github.com/gradle/actions/compare/v3.4.1...v3.4.2

This patch release fixes a bug introduced in v3.4.0, that prevents build scan publication to Develocity.
The bug results in the removal of the DEVELOCITY_ACCESS_KEY variable being removed, so that Gradle cannot authenticate with the Develocity server.

What's Changed

• Don't clear access key when access token cannot be obtained by @cdsap in https://github.com/gradle/actions/pull/258
• Simplify requesting short-lived Develocity access tokens by @bigdaz in https://github.com/gradle/actions/pull/259

Full Changelog: https://github.com/gradle/actions/compare/v3.4.0...v3.4.1

This release improves the integration with Gradle Develocity®, as well as updating a number of key dependencies.

• The new develocity-access-key input parameter allows the action to generate a short-lived access token for subsequent
  communication with Develocity. This reduces the risk of the full (long-lived) access key being compromised,
  either accidentally or by a malicious action.
• New input parameters are available to configure Develocity injection. Previously Develocity injection could only be
  enabled by setting environment variables.
• Checksums for Gradle 8.8 are now included, so that no network request is required for wrapper-validation with Gradle 8.8 wrappers.

What's Changed

• Add support for short-lived tokens by @alextu in https://github.com/gradle/actions/pull/224
• Update known wrapper checksums by @github-actions in https://github.com/gradle/actions/pull/240
• Update to Gradle 8.8 by @bigdaz in https://github.com/gradle/actions/pull/251
• Adding Develocity input actions by @cdsap in https://github.com/gradle/actions/pull/244
• Fail on invalid boolean for Develocity inputs by @bigdaz in https://github.com/gradle/actions/pull/252

New Contributors

• @serieznyi made their first contribution in https://github.com/gradle/actions/pull/216
• @lokalpage-safe made their first contribution in https://github.com/gradle/actions/pull/205
• @alextu made their first contribution in https://github.com/gradle/actions/pull/224
• @bot-githubaction made their first contribution in https://github.com/gradle/actions/pull/227
• @antonmos made their first contribution in https://github.com/gradle/actions/pull/234
• @cdsap made their first contribution in https://github.com/gradle/actions/pull/244

Full Changelog: https://github.com/gradle/actions/compare/v3.3.2...v3.4.0

This patch release fixes a bug in both dependency-submission and setup-gradle (#196 introduced in v3.3.1), which resulted in
"No dependency-graph files found to submit" when using the download-and-submit function.
A number of other minor issues have also been addressed:

What's Changed

• [dependency-submission] Fix bug finding dependency-graph files with 'download-and-submit' (#199)
• [dependency-submission] Use Gradle logger instead of println in dependency graph init script (#191 from @aleksandrserbin)
• [dependency-submission] Retain and log full stacktrace for dependency submission errors (#192)
• [setup-gradle] Improve build scan badge readability with long task names (#200 from @gabrielfeo)

Full Changelog: https://github.com/gradle/actions/compare/v3.3.1...v3.3.2

This patch release fixes a bug in setting the report dir for dependency-submission, and updates the plugin versions
applied in Develocity injection.

What's Changed

• Bump Develocity and CCUD plugin versions (#185)
• Support custom DEPENDENCY_GRAPH_REPORT_DIR variable for dependency-submission (#188)

Full Changelog: https://github.com/gradle/actions/compare/v3.3.0...v3.3.1

This release includes a new action, and improvements to the existing actions.

Highlights include:

• New wrapper-validation action to replace the gradle/wrapper-validation-action action
• Converted dependency-submission action to Typescript. This enabled other important features, like submitting the dependency graph in the same step that it is generated.
• Better caching support for Gradle 8.6+ in setup-gradle

[!IMPORTANT]
The caching protocol version has changed in this release, so cache entries written with previous versions of the action will not be reused. This means that jobs will effectively start with an empty cache after switching to this release.

Changelog

NEW action gradle/actions/wrapper-validation

• [NEW] Add replacement for wrapper-validation-action (#160)

Improvements to gradle/actions/setup-gradle

• [NEW] Cache paths have been updated for Gradle 8.6+ (#45, #163)
• [NEW] setup-gradle action can now perform wrapper-validation automatically (#161, #162)
• [FIX] Make cache-keys more consistent (#131).
• [FIX] Avoid listing old build results in Job Summary on self-hosted runner (#127)
• [FIX] Deprecation warnings are emitted when using deprecated inputs (#108)
• [FIX] Generate correct toolchains.xml file on ARM runners (#89)

Improvements to gradle/actions/depenency-submission

• [NEW] Action is now implemented directly in TypeScript, and does not delegate to setup-gradle (#116)
• [NEW] Allow dependency resolution task name to be specified (#125)
• [NEW] Dependency-graph is submitted immediately with dependency-submission action (#123)
• [FIX] setup-gradle and dependency-submission can be used in the same Job (#36)

Full Changelog: https://github.com/gradle/actions/compare/v3.2.1...v3.3.0

Actions Summary

Release includes v3.3.0 of the following, available under the v3 version tag:

• gradle/actions/setup-gradle
• gradle/actions/dependency-submission
• gradle/actions/wrapper-validation

[!NOTE]
The gradle/actions/setup-gradle action supersedes gradle/gradle-build-action.
The gradle/actions/wrapper-validation action supersedes gradle/wrapper-validation-action.

The recent update to use com.develocity.gradle plugin resulted in many deprecation warnings being triggered by the init-scripts bundled with this action. This patch release updates these init-scripts to avoid these deprecation warnings.

What's Changed

• Fix Develocity deprecation warnings in v3.2.1 (#126) by #129

Full Changelog: https://github.com/gradle/actions/compare/v3.2.0...v3.2.1

Changelog

General improvements

• [NEW] Support authentication for plugin repositories (#31)
• [FIX] Improve rendering of build results table with long values (#35)

Improvements to Dependency Submission

• [FIX] Do not attempt to resolve dependency configurations that are excluded via env var (#107)

Improvements to Develocity injection

• [NEW] Use com.develocity.gradle plugin version 3.17 by default
• [NEW] Can configure capture of file-fingerprint (#58)
• [FIX] Reduce log-level of messages emitted by Develocity injection (#60)

Note

Release includes v3.2.0 of gradle/actions/setup-gradle and gradle/actions/dependency-submission.
Available under the v3 version tag.

The gradle/actions/setup-gradle action supersedes gradle/gradle-build-action.
The gradle/[email protected] version will be released in parallel, and will delegate to this release of gradle/actions/setup-gradle.

Full Changelog: https://github.com/gradle/actions/compare/v3.1.0...v3.2.0

This release provides more Gradle output when running with actions debug logging, and fixes some minor issues with gradle/actions/dependency-submission.

Changelog

• [NEW] Support ACTIONS_STEP_DEBUG mode (#6)
• [NEW] Provide link to GitHub job in generated PR comment (#11)
• [NEW] Report source of dependency in dependency-graph via debug logging (#44)
• [FIX] Unknown command-line option '--dependency-verification' with Gradle 5.6 (#15)
• [FIX] Dependency submission action should handle non-executable gradlew script (#17)
• [FIX] Dependency submission fails when project isolation is enabled (#39)
• [FIX] Incomplete dependency-graph is submitted on build failure (#43)

Full changelog: https://github.com/gradle/actions/compare/v3.0.0...v3.1.0

Note

Release includes v3.1.0 of gradle/actions/setup-gradle and gradle/actions/dependency-submission.
Available under the v3 version tag.

The gradle/actions/setup-gradle action supersedes gradle/gradle-build-action.
The gradle/[email protected] version will be released in parallel, and will delegate to this release of gradle/actions/setup-gradle.

Release includes v3.0.0 of gradle/actions/setup-gradle and gradle/actions/dependency-submission.
This is the first available under the v3 version tag.

The gradle/actions/setup-gradle action supersedes gradle/gradle-build-action.
The gradle/[email protected] version will be released in parallel, and will delegate to this release of gradle/actions/setup-gradle.

Changes from gradle-build-action@v2

This release brings some useful and much requested features, including:

• save and restore the Gradle configuration-cache data
• add the Job summary content as a PR comment
• easily publish Build Scans® to the free Gradle Build Scan service
• compatibility with Node 20

The only major breaking change from [email protected] is the update to require a Node 20 runtime environment.
Aside from that change, this release should generally serve as a drop-in replacement for gradle-build-action@v2.

Changelog

• [NEW] - Run with NodeJs 20.x (https://github.com/gradle/gradle-build-action/issues/946)
• [NEW] - Support for save & restore of configuration-cache data (https://github.com/gradle/gradle-build-action/issues/966)
• [NEW] - Support for automatic adding PR comment with Job Summary content (https://github.com/gradle/gradle-build-action/issues/1020)
• [NEW] - Make it easy to publish a Build Scan® to https://scans.gradle.com (https://github.com/gradle/gradle-build-action/issues/1044)
• [NEW] - Added dependency-graph-continue-on-failure input, which can be set to false to force the Job to fail when dependency graph submission fails (https://github.com/gradle/gradle-build-action/issues/1036). Failure modes include:
  • Fail build step if version of Gradle being executed is not supported for dependency-graph generation (https://github.com/gradle/gradle-build-action/issues/1034)
  • Fail job if permissions are insufficient to submit dependency graph via Dependency Submission API (https://github.com/gradle/gradle-build-action/issues/997)
• [NEW] - Add dependency-graph: clear option to clear any dependency-graph previously submitted by the job
• [FIX] Allow cache entries to be reused by jobs with the same ID in different workflows (https://github.com/gradle/gradle-build-action/issues/1017)
  • Workflow name remains part of the cache key, but cache entries generated by the same job id in a different workflow may be restored
• [FIX] Register pre-installed JDKs in Maven toolchains.xml file (https://github.com/gradle/gradle-build-action/issues/1024)
  • This allows pre-installed JDKs to be auto-detected by Gradle Toolchain support on Windows
• [FIX] - Update the Gradle Enterprise injection configuration for product rename to Develocity (https://github.com/gradle/gradle-build-action/issues/995)
• [FIX] - Avoid submitting an empty dependency graph when state is loaded from configuration-cache
• [FIX] - Update to GitHub Dependency Graph Gradle Plugin v1.2.0
• [DEPRECATION] - Deprecation of the arguments parameter (https://github.com/gradle/gradle-build-action/issues/996)
• [BREAKING CHANGE] - Remove the gradle-executable input parameter. Use a separate workflow Step to execute a Gradle from a custom location.

Release candidate for v3.0.0 of gradle/actions/setup-gradle and gradle/actions/dependency-submission.
This release candidate is available under the v3 version tag.

The gradle/actions/setup-gradle action supersedes gradle/gradle-build-action.
The gradle/[email protected] version will be released in parallel, and will delegate to this release of gradle/actions/setup-gradle.

First release candidate for v3.0.0 of gradle/actions/setup-gradle and gradle/actions/dependency-submission.
This release candidate will the first release available under the v3 version tag.

The gradle/[email protected] version will be released in parallel, and will delegate to gradle/actions/[email protected].

Full release notes will be made available with the final v3.0.0 release.

First release of gradle/actions, which is a replacement for gradle/gradle-build-action and so much more.

Included in this release:

• gradle/actions/setup-gradle : drop-in replacement for gradle/gradle-build-action
• gradle/actions/dependency-submission: specialized action for generating and submitting dependency graphs

These actions be referenced as gradle/actions/<action-name>@v3.0.0-beta.6 or gradle/actions/<action-name>@v3-beta.

There are no functional changes between gradle/[email protected] and gradle/actions/[email protected].