gradle-build-action

What's fixed

Fixes a bug where a corrupted cache entry caused an error in beforeSave (#408). This meant that the entry was never purged.
By allowing @actions/globber to follow symlinks and ignore broken symlinks, the bad files in the cache entry are ignored and the corrupted cache entry can be replaced by a good one.

Full Changelog: https://github.com/gradle/gradle-build-action/compare/v2.2.4...v2.2.5

What's fixed

The fix for #383 introduced a bug that caused the post-action to fail when attempting to resolve cache-read-only for scheduled jobs.
This has been fixed with an explicit (rather than implicit) check for 'event.repository != null'. (#409)

Full Changelog: https://github.com/gradle/gradle-build-action/compare/v2.2.3...v2.2.4

What's fixed

This release updates a number of key dependencies and fixes some cache-related issues:

• Do not set cache-read-only=true for scheduled workflows on default branch (#383)
• Fix reporting of caching errors that was broken in v2.2.2 (#407)
• Abort cache download operations after 10 minutes (configurable). Previously cache download operations could hang the build. (#369)

Full Changelog: https://github.com/gradle/gradle-build-action/compare/v2.2.2...v2.2.3

What's fixed

This release fixes some issues that were discovered in the v2.2.1 release, and updates a number of dependencies.

• Improved support for GitHub Enterprise
  • Do not attempt to use GitHub Actions cache when the feature is not available
  • Write Gradle Build summary to log files when Job Summary functionality not available
• Only attempt to stop Gradle daemons when caching Gradle User Home (#341)
• Only write build-results file when GitHub Actions env vars are available (#350)

Full Changelog: https://github.com/gradle/gradle-build-action/compare/v2.2.1...v2.2.2

What's fixed

This release fixes some issues that were exposed by the v2.2.0 release, as well as improving the content and layout of the Job Summary.

• Don't try to generate Job Summary when functionality is not available (GitHub Enterprise): #319
• Fix warning when attempting to delete non-existent file: #308
• Fix Entry not saved: reason unknown message in Job Summary cache details: #309
• Report failure to publish build scan in Job Summary: #326

Full Changelog: https://github.com/gradle/gradle-build-action/compare/v2.2.0...v2.2.1

Summary

This release brings a new Job Summary report, as well as numerous improvements and bug fixes:

• Capture all Gradle build executions for a job and write them to the GitHub Actions Job Summary.
• Default to cache-read-only for non-default branches (see 0a36ca9fb8a7acc820f34da9116f389a13dc67e2)
• Allow the Gradle Daemon to run across build steps in a workflow Job (see #113)

Issues resolved

https://github.com/gradle/gradle-build-action/milestone/7?closed=1

What's Changed

• Use GHA Job Summary to summarize Gradle build results by @bigdaz in https://github.com/gradle/gradle-build-action/pull/282
• Various improvements to CI workflows by @bigdaz in https://github.com/gradle/gradle-build-action/pull/294
• Extract init scripts and state tracking by @bigdaz in https://github.com/gradle/gradle-build-action/pull/297
• Add improved Job Summary with build results and caching report by @bigdaz in https://github.com/gradle/gradle-build-action/pull/298
• Fix save/restore of configuration-cache by @bigdaz in https://github.com/gradle/gradle-build-action/pull/302
• Improve layout and formatting of Job Summary by @bigdaz in https://github.com/gradle/gradle-build-action/pull/303
• Default to cache-read-only for non-default branches by @bigdaz in https://github.com/gradle/gradle-build-action/pull/149
• Improve init scripts and add test coverage by @bigdaz in https://github.com/gradle/gradle-build-action/pull/304
• Allow daemons to run across workflow steps by @bigdaz in https://github.com/gradle/gradle-build-action/pull/305
• Use java to determine user.home dir by @bigdaz in https://github.com/gradle/gradle-build-action/pull/306

Full Changelog: https://github.com/gradle/gradle-build-action/compare/v2.1.7...v2.2.0

Wait a bit longer and report failures better for file locking issues: 8096e65e0ac33934b80b58fe4d0de1adc7bc586b

First RC of v2.2.0 release. See v2.2.0 closed issues for details.

Fixes #293, which prevented v2.1.6 from allowing Gradle to re-use previously downloaded wrapper distributions. This slowed down build executions and could result in build flakiness when the wrapper zip failed to download.

• [FIX] Retain more items in the wrapper folder of Gradle User Home, avoiding re-download of wrapper distributions.

First cut at using GHA Job Summary to display Gradle Build results

This release contains an fix for changed behaviour in Gradle 7.6, as well as numerous library upgrades.

Earlier versions of the gradle-build-action were saving and restoring the downloaded Gradle wrapper zip file as part of caching the Gradle User Home. This will no longer work with Gradle 7.6, as the wrapper zip is now removed after expanding. This release of gradle-build-action contains a fix for this change in Gradle 7.6. Using an older version of the GitHub action with Gradle 7.6 will likely result in the wrapper being downloaded on every GitHub actions invocation.

What's Changed

• [FIX] Save/restore exploded Gradle dist rather than zip
• [FIX] Update to the latest versions of @actions/core, @actions/cache, @actions/github, @actions/http-client and @actions/tool-cache.

Full changelog: https://github.com/gradle/gradle-build-action/compare/v2.1.5...v2.1.6

This release addresses a potential security issue by upgrading minimist, and fixes a bug with very large cache entries by upgrading @actions/cache. No other changes are included.

What's Changed

• [FIX] - Upgrade minimist from 1.2.5 -> 1.2.6
• [FIX] - Support cache entries > 2Gb via library upgrade to @actions/cache from 1.0.10 -> 2.0.0.

Full changelog: https://github.com/gradle/gradle-build-action/compare/v2.1.4...v2.1.5

What's Changed

• Updated dependency versions: d700906a155ae3ddc36d15f41d1ac83e8623287c.
• Log stack trace for cache errors that are reported as warnings.

Full Changelog: https://github.com/gradle/gradle-build-action/compare/v2.1.3...v2.1.4

This patch release fixes an issue that prevented the Gradle User Home from being restored from cache on macos-latest runners. #155

What's Changed

• Fix detection of Gradle User Home on macOS runners by @bigdaz in https://github.com/gradle/gradle-build-action/pull/156

Full Changelog: https://github.com/gradle/gradle-build-action/compare/v2.1.2...v2.1.3

This patch release fixes a minor bug and updates some NPM dependencies, including one dependency with a reported security advisory.

What's Changed

• Fixed #147: existing gradle.properties is no longer overwritten by action initialization
• Updated all NPM dependencies to the latest version
  • This included updating node-fetch to a version that isn't impacted by https://github.com/advisories/GHSA-r683-j2x4-v87g. Note that this CVE has been determined not to impact the action.

Full Changelog: https://github.com/gradle/gradle-build-action/compare/v2.1.1...v2.1.2

This release improves logging and fixes a number of minor issues.

• Fix misleading error message when gradlew script is not executable #76
• Differentiate between build scan links generated for different steps in the same Job #124
• Avoid overwriting existing Gradle User Home #138
• Capture build scan links even when cache is disabled #139

In addition, 2 experimental configuration parameters have been added:

• gradle-home-cache-strict-match: Only reuse cache entries generated by previous invocations for the same job
• cache-write-only: Do not restore cache entries but save on Job completion

Full Changelog: https://github.com/gradle/gradle-build-action/compare/v2.1.0...v2.1.1

Overview

This release brings a major improvement in usability, allowing the action to be used to "setup Gradle" without requiring all Gradle invocations to be managed by the action.

jobs:
  build-my-app:
    steps:
    - uses: actions/checkout@v2
    - name: Setup Gradle
      uses: gradle/gradle-build-action@v2
    - name: Execute Gradle build
      run: ./gradlew build

Any Gradle invocation after the first gradle-build-action step will benefit from caching and build-scan capture just as if it was invoked through a subsequent gradle-build-action. This is achieved via init scripts added when initializing/restoring the Gradle User Home.

This change makes it easier to adopt the gradle-build-action into an existing GitHub Actions workflow and enables usages such as:

• Redirect all Gradle log output to a file #72
• Run a script to configure the environment prior to Gradle invocation #15
• Capture Gradle output for use in a subsequent step #112

Usability improvements

• Can use regular run step to invoke Gradle and still benefit from Gradle User Home caching as well as build-scan integration.

Caching improvements

• Wrapper distributions and generated API jars are now cached individually, allowing for better reuse and more efficient storage: #78
• Java distributions downloaded by Gradle are cached: #33

Changes in detail

• Avoid using command-line modification to enhance build execution by @bigdaz in https://github.com/gradle/gradle-build-action/pull/123
• Refactor: use a single .json file to describe all cached artifact bundles by @bigdaz in https://github.com/gradle/gradle-build-action/pull/121
• Cache wrapper zips and generated jars individually by @bigdaz in https://github.com/gradle/gradle-build-action/pull/127
• Restore/save configuration-cache data in first action step by @bigdaz in https://github.com/gradle/gradle-build-action/pull/128
• Allow action to be used without Gradle execution by @bigdaz in https://github.com/gradle/gradle-build-action/pull/130
• Cache downloaded Java Toolchains by @bigdaz in https://github.com/gradle/gradle-build-action/pull/131

Full Changelog: https://github.com/gradle/gradle-build-action/compare/v2.0.0...v2.1.0

What's Changed

This patch release fixes a couple of cases where a failure to store caches would cause the entire Job to fail. The goal of the gradle-build-action is to warn-and-continue on all recoverable cache failures.

Issues fixed

• Cache upload failure because file read failed should not cause step to fail #120
• SyntaxError: Unexpected end of JSON input should not cause step to fail #119

Full Changelog: https://github.com/gradle/gradle-build-action/compare/v2.0.0...v2.0.1

This is the initial release of gradle-build-action@v2, which brings significant performance and usability improvements over v1. A few key improvements are outlined here, but see the project README for more details.

Thanks for trying it out!

Usability improvements:

The gradle-build-action has been redesigned from the ground up to work well with minimal configuration, avoiding the need for most users to tweak multiple configuration options to benefit.

Highlights:

• Simplified and improved configuration options, with better support for more Gradle builds "out of the box".
• More robust capture of Build Scan™ links, which are now added directly as Notice annotations to your workflow run.
• Support for multi-line arguments in workflow definitions.

Performance improvements:

A key benefit of gradle-build-action over other solutions is the sophisticated support for saving and restoring relevant Gradle state between build invocations. This caching support speeds up build invocations and is designed to work in most scenarios without further tweaking.

Highlights:

• Support for caching of more state between Gradle invocations, including compiled build scripts and generated Gradle API jars as well as downloaded dependencies and Gradle distributions.
• Common files such as downloaded dependencies and wrapper distributions are cached in a more efficient manner, with the goal to cut cache-entry size and reduce eviction pressure.
• Detailed reporting of cache usage and cache configuration options allow you to optimize the use of the GitHub actions cache.

Adds a useful report outlining cache entries restored/saved, and fixes a few issues found in v2.0-rc.1.

• All dependency files are not included in dependencies cache bundle, instead of just .jar files (#100)
• gradle-home-cache-includes and gradle-home-cache-excludes are now multi-line inputs (#106)
• Only restore configuration-cache state when all of Gradle User Home is restored (#107)
• Report on cache entry keys and sizes in post-action