From 8547b4a85ed22c8dfcb6b8ff590e504a8e96a38a Mon Sep 17 00:00:00 2001 From: Alexandr Evstigneev Date: Sat, 4 Mar 2023 08:35:25 +0400 Subject: [PATCH] Added gradle.properties file to the cache key Part of project configuration may be in the `gradle.properties` file and changing it should invalidate cache See: https://docs.gradle.org/current/userguide/build_environment.html#sec:gradle_configuration_properties --- README.md | 2 +- __tests__/cache.test.ts | 10 +++++++++- src/cache.ts | 3 ++- 3 files changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bd9a411ad..94a920995 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ Currently, the following distributions are supported: ### Caching packages dependencies The action has a built-in functionality for caching and restoring dependencies. It uses [actions/cache](https://github.com/actions/cache) under hood for caching dependencies but requires less configuration settings. Supported package managers are gradle, maven and sbt. The format of the used cache key is `setup-java-${{ platform }}-${{ packageManager }}-${{ fileHash }}`, where the hash is based on the following files: -- gradle: `**/*.gradle*`, `**/gradle-wrapper.properties`, `buildSrc/**/Versions.kt`, `buildSrc/**/Dependencies.kt`, and `gradle/*.versions.toml` +- gradle: `**/*.gradle*`, `**/gradle-wrapper.properties`, `buildSrc/**/Versions.kt`, `buildSrc/**/Dependencies.kt`, `gradle.properties` and `gradle/*.versions.toml` - maven: `**/pom.xml` - sbt: all sbt build definition files `**/*.sbt`, `**/project/build.properties`, `**/project/**.{scala,sbt}` diff --git a/__tests__/cache.test.ts b/__tests__/cache.test.ts index 987da4a08..49a262ed7 100644 --- a/__tests__/cache.test.ts +++ b/__tests__/cache.test.ts @@ -98,7 +98,7 @@ describe('dependency cache', () => { await expect(restore('gradle')).rejects.toThrowError( `No file in ${projectRoot( workspace - )} matched to [**/*.gradle*,**/gradle-wrapper.properties,buildSrc/**/Versions.kt,buildSrc/**/Dependencies.kt,gradle/*.versions.toml], make sure you have checked out the target repository` + )} matched to [**/*.gradle*,**/gradle-wrapper.properties,buildSrc/**/Versions.kt,buildSrc/**/Dependencies.kt,gradle/*.versions.toml,gradle.properties], make sure you have checked out the target repository` ); }); it('downloads cache based on build.gradle', async () => { @@ -121,6 +121,14 @@ describe('dependency cache', () => { createDirectory(join(workspace, 'gradle')); createFile(join(workspace, 'gradle', 'libs.versions.toml')); + await restore('gradle'); + expect(spyCacheRestore).toBeCalled(); + expect(spyWarning).not.toBeCalled(); + expect(spyInfo).toBeCalledWith('gradle cache is not found'); + }); + it('downloads cache based on gradle.properties', async () => { + createFile(join(workspace, 'gradle.properties')); + await restore('gradle'); expect(spyCacheRestore).toBeCalled(); expect(spyWarning).not.toBeCalled(); diff --git a/src/cache.ts b/src/cache.ts index 20b553e82..f4f594bdd 100644 --- a/src/cache.ts +++ b/src/cache.ts @@ -36,7 +36,8 @@ const supportedPackageManager: PackageManager[] = [ '**/gradle-wrapper.properties', 'buildSrc/**/Versions.kt', 'buildSrc/**/Dependencies.kt', - 'gradle/*.versions.toml' + 'gradle/*.versions.toml', + 'gradle.properties' ] }, {