Add versions properties to cache by Endi327 · Pull Request #280 · actions/setup-java · GitHub

Description:
When using refreshVersions plugin, all the versions are managed in one particular file called versions.properties. This file is created by the plugin in the root directory and only used for handling versions in one place. As you can see they have quite a huge user base, so this would help a lot of users.

This PR adds the files **/versions.properties to the cache key calculation (in addition to the existing **/.gradle, **/gradle-wrapper.properties).

Related issue:
None.

Check list:

Mark if documentation changes are required.
Mark if tests were added or updated to cover the changes.

Hello @Endi327. Thank you for your pull request. I think it looks good, just some minor questions.

Does the pull request related to Include version catalog file in filehash in the Gradle cache key #237 ?
Do you know how often file is changed ?
If it's possible, could you please attach public repository for testing purposes.

Hello @dmitry-shibanov. Thank you for your reply. Let me answer your questions:

Does the pull request related to Include version catalog file in filehash in the Gradle cache key Include version catalog file in filehash in the Gradle cache key #237 ? -> The basic idea is the same, we would like to handle all versions in one specific file. However, Include version catalog file in filehash in the Gradle cache key #237 is about using version catalog and my PR is about using refreshVersions plugin or handling all dependency version in versions.properties file.
Do you know how often file is changed ? -> It will change every time we add a new dependency or looking for updates and run ./gradlew refreshVersions.
If it's possible, could you please attach public repository for testing purposes. -> Yes, I have a public repository: https://github.com/Endi327/fortnightly/tree/feature/refreshVersions. I already configured the refreshVersion plugin and to use my forked version of actions/setup-java.

Hello @Endi327. Thank you for your response. About the second question I'm just curious about it because I do not want to cause constant saving of the cache. It'll lead to the longer builds. How often will the ./gradlew refreshVersions command be used ?
I'll test with your changes. For now I'll start up checks on the CI.
Thank you!

Could you please run the npm run format command.

npm run format change

@dmitry-shibanov It is depending on the team/developer. It is possible that it will run every time before creating a new pull request, but the file will only change if the task find a new available version for one of the 3rd party dependencies. So there is no exact method to count the frequency because all dependency has its own schedule for updates. We will create an action to run it every two weeks.
I updated my project with a fix, please use the latest commit (b271e04ed9d60ce8042a7c5cfbedfa2584d48d50) as head on feature/refreshVersion.
I also updated my pull request with the lint fix, npm run format pointed out the issue.

@dmitry-shibanov Updated the unit tests so now all checks have passed.

@dmitry-shibanov Is there any update on this?

Hello @Endi327. Sorry for the late response. Could you please sync with the main branch ?

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | actions/setup-java | action | digest | `cd89f46` -> `b943a4e` | | [actions/setup-java](https://togithub.com/actions/setup-java) | action | minor | `v3.11.0` -> `v3.12.0` | | [actions/setup-java](https://togithub.com/actions/setup-java) | action | digest | `5ffc13f` -> `cd89f46` | | [github/codeql-action](https://togithub.com/github/codeql-action) | action | patch | `v2.21.0` -> `v2.21.2` | | [gradle/gradle-build-action](https://togithub.com/gradle/gradle-build-action) | action | minor | `v2.6.1` -> `v2.7.0` | --- ### ⚠ Dependency Lookup Warnings ⚠ Warnings were logged while processing this repo. Please check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>actions/setup-java (actions/setup-java)</summary> ### [`v3.12.0`](https://togithub.com/actions/setup-java/releases/tag/v3.12.0) [Compare Source](https://togithub.com/actions/setup-java/compare/v3.11.0...v3.12.0) In scope of this release the following changes were made: **Bug fixes:** - Always check postfix "Contents/Home" on macOS by [@erwin1](https://togithub.com/erwin1) in [https://github.com/actions/setup-java/pull/397](https://togithub.com/actions/setup-java/pull/397) - Fix sbt/scala cache key by [@Dogacel](https://togithub.com/Dogacel) in [https://github.com/actions/setup-java/pull/478](https://togithub.com/actions/setup-java/pull/478) - Corretto toolcache folder name fix by [@IvanZosimov](https://togithub.com/IvanZosimov) in [https://github.com/actions/setup-java/pull/480](https://togithub.com/actions/setup-java/pull/480) - Update versions of Oracle JDK and Microsoft Build of OpenJDK by [@anishi1222](https://togithub.com/anishi1222) in [https://github.com/actions/setup-java/pull/489](https://togithub.com/actions/setup-java/pull/489) - Update Oracle JDK download URL calculation by [@nikolai-laevskii](https://togithub.com/nikolai-laevskii) in [https://github.com/actions/setup-java/pull/507](https://togithub.com/actions/setup-java/pull/507) **Feature implementations:** - Add versions properties to cache by [@Endi327](https://togithub.com/Endi327) in [https://github.com/actions/setup-java/pull/280](https://togithub.com/actions/setup-java/pull/280) **Resolving dependencies issues:** - Remove implicit dependencies by [@nikolai-laevskii](https://togithub.com/nikolai-laevskii) in [https://github.com/actions/setup-java/pull/494](https://togithub.com/actions/setup-java/pull/494) - Update xml2js by [@dmitry-shibanov](https://togithub.com/dmitry-shibanov) in [https://github.com/actions/setup-java/pull/484](https://togithub.com/actions/setup-java/pull/484) - Update dependencies by [@IvanZosimov](https://togithub.com/IvanZosimov) in [https://github.com/actions/setup-java/pull/511](https://togithub.com/actions/setup-java/pull/511) **Infrastructure updates:** - Fix glob bug in package.json scripts section by [@IvanZosimov](https://togithub.com/IvanZosimov) in [https://github.com/actions/setup-java/pull/475](https://togithub.com/actions/setup-java/pull/475) - Update mocks by [@nikolai-laevskii](https://togithub.com/nikolai-laevskii) in [https://github.com/actions/setup-java/pull/498](https://togithub.com/actions/setup-java/pull/498) **Documentation changes:** - Instruction to download custom distribution JDK and install by [@ragsmpl](https://togithub.com/ragsmpl) in [https://github.com/actions/setup-java/pull/500](https://togithub.com/actions/setup-java/pull/500) #### New Contributors - [@erwin1](https://togithub.com/erwin1) made their first contribution in [https://github.com/actions/setup-java/pull/397](https://togithub.com/actions/setup-java/pull/397) - [@Dogacel](https://togithub.com/Dogacel) made their first contribution in [https://github.com/actions/setup-java/pull/478](https://togithub.com/actions/setup-java/pull/478) - [@anishi1222](https://togithub.com/anishi1222) made their first contribution in [https://github.com/actions/setup-java/pull/489](https://togithub.com/actions/setup-java/pull/489) - [@nikolai-laevskii](https://togithub.com/nikolai-laevskii) made their first contribution in [https://github.com/actions/setup-java/pull/498](https://togithub.com/actions/setup-java/pull/498) - [@ragsmpl](https://togithub.com/ragsmpl) made their first contribution in [https://github.com/actions/setup-java/pull/500](https://togithub.com/actions/setup-java/pull/500) - [@Endi327](https://togithub.com/Endi327) made their first contribution in [https://github.com/actions/setup-java/pull/280](https://togithub.com/actions/setup-java/pull/280) **Full Changelog**: actions/setup-java@v3...v3.12.0 </details> <details> <summary>github/codeql-action (github/codeql-action)</summary> ### [`v2.21.2`](https://togithub.com/github/codeql-action/compare/v2.21.1...v2.21.2) [Compare Source](https://togithub.com/github/codeql-action/compare/v2.21.1...v2.21.2) ### [`v2.21.1`](https://togithub.com/github/codeql-action/compare/v2.21.0...v2.21.1) [Compare Source](https://togithub.com/github/codeql-action/compare/v2.21.0...v2.21.1) </details> <details> <summary>gradle/gradle-build-action (gradle/gradle-build-action)</summary> ### [`v2.7.0`](https://togithub.com/gradle/gradle-build-action/releases/tag/v2.7.0) [Compare Source](https://togithub.com/gradle/gradle-build-action/compare/v2.6.1...v2.7.0) ##### GitHub Dependency Graph support In this release, the GitHub Dependency Graph support is no longer considered "experimental", and should be considered ready for production use. You can read more about the Dependency Graph support in [the README chapter](https://togithub.com/gradle/gradle-build-action#github-dependency-graph-support). ##### Changes - Update to [`github-dependency-graph-gradle-plugin@v0.2.0`](https://plugins.gradle.org/plugin/org.gradle.github-dependency-graph-gradle-plugin/0.2.0) - Dependency graph uses Gradle Settings file as manifest location (if Settings file exists) - Adds a `dependency-graph-file` output to any step that generates a Dependency Graph file ##### Changelog </details> --- ### Configuration 📅 **Schedule**: Branch creation - "every weekend" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/slsa-framework/slsa-github-generator).  --------- Signed-off-by: Mend Renovate <bot@renovateapp.com> Signed-off-by: Ian Lewis <ianlewis@google.com> Co-authored-by: Ian Lewis <ianlewis@google.com>

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | actions/setup-java | action | digest | `cd89f46` -> `b943a4e` | | [actions/setup-java](https://togithub.com/actions/setup-java) | action | minor | `v3.11.0` -> `v3.12.0` | | [actions/setup-java](https://togithub.com/actions/setup-java) | action | digest | `5ffc13f` -> `cd89f46` | | [github/codeql-action](https://togithub.com/github/codeql-action) | action | patch | `v2.21.0` -> `v2.21.2` | | [gradle/gradle-build-action](https://togithub.com/gradle/gradle-build-action) | action | minor | `v2.6.1` -> `v2.7.0` | --- ### ⚠ Dependency Lookup Warnings ⚠ Warnings were logged while processing this repo. Please check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>actions/setup-java (actions/setup-java)</summary> ### [`v3.12.0`](https://togithub.com/actions/setup-java/releases/tag/v3.12.0) [Compare Source](https://togithub.com/actions/setup-java/compare/v3.11.0...v3.12.0) In scope of this release the following changes were made: **Bug fixes:** - Always check postfix "Contents/Home" on macOS by [@erwin1](https://togithub.com/erwin1) in [https://github.com/actions/setup-java/pull/397](https://togithub.com/actions/setup-java/pull/397) - Fix sbt/scala cache key by [@Dogacel](https://togithub.com/Dogacel) in [https://github.com/actions/setup-java/pull/478](https://togithub.com/actions/setup-java/pull/478) - Corretto toolcache folder name fix by [@IvanZosimov](https://togithub.com/IvanZosimov) in [https://github.com/actions/setup-java/pull/480](https://togithub.com/actions/setup-java/pull/480) - Update versions of Oracle JDK and Microsoft Build of OpenJDK by [@anishi1222](https://togithub.com/anishi1222) in [https://github.com/actions/setup-java/pull/489](https://togithub.com/actions/setup-java/pull/489) - Update Oracle JDK download URL calculation by [@nikolai-laevskii](https://togithub.com/nikolai-laevskii) in [https://github.com/actions/setup-java/pull/507](https://togithub.com/actions/setup-java/pull/507) **Feature implementations:** - Add versions properties to cache by [@Endi327](https://togithub.com/Endi327) in [https://github.com/actions/setup-java/pull/280](https://togithub.com/actions/setup-java/pull/280) **Resolving dependencies issues:** - Remove implicit dependencies by [@nikolai-laevskii](https://togithub.com/nikolai-laevskii) in [https://github.com/actions/setup-java/pull/494](https://togithub.com/actions/setup-java/pull/494) - Update xml2js by [@dmitry-shibanov](https://togithub.com/dmitry-shibanov) in [https://github.com/actions/setup-java/pull/484](https://togithub.com/actions/setup-java/pull/484) - Update dependencies by [@IvanZosimov](https://togithub.com/IvanZosimov) in [https://github.com/actions/setup-java/pull/511](https://togithub.com/actions/setup-java/pull/511) **Infrastructure updates:** - Fix glob bug in package.json scripts section by [@IvanZosimov](https://togithub.com/IvanZosimov) in [https://github.com/actions/setup-java/pull/475](https://togithub.com/actions/setup-java/pull/475) - Update mocks by [@nikolai-laevskii](https://togithub.com/nikolai-laevskii) in [https://github.com/actions/setup-java/pull/498](https://togithub.com/actions/setup-java/pull/498) **Documentation changes:** - Instruction to download custom distribution JDK and install by [@ragsmpl](https://togithub.com/ragsmpl) in [https://github.com/actions/setup-java/pull/500](https://togithub.com/actions/setup-java/pull/500) #### New Contributors - [@erwin1](https://togithub.com/erwin1) made their first contribution in [https://github.com/actions/setup-java/pull/397](https://togithub.com/actions/setup-java/pull/397) - [@Dogacel](https://togithub.com/Dogacel) made their first contribution in [https://github.com/actions/setup-java/pull/478](https://togithub.com/actions/setup-java/pull/478) - [@anishi1222](https://togithub.com/anishi1222) made their first contribution in [https://github.com/actions/setup-java/pull/489](https://togithub.com/actions/setup-java/pull/489) - [@nikolai-laevskii](https://togithub.com/nikolai-laevskii) made their first contribution in [https://github.com/actions/setup-java/pull/498](https://togithub.com/actions/setup-java/pull/498) - [@ragsmpl](https://togithub.com/ragsmpl) made their first contribution in [https://github.com/actions/setup-java/pull/500](https://togithub.com/actions/setup-java/pull/500) - [@Endi327](https://togithub.com/Endi327) made their first contribution in [https://github.com/actions/setup-java/pull/280](https://togithub.com/actions/setup-java/pull/280) **Full Changelog**: actions/setup-java@v3...v3.12.0 </details> <details> <summary>github/codeql-action (github/codeql-action)</summary> ### [`v2.21.2`](https://togithub.com/github/codeql-action/compare/v2.21.1...v2.21.2) [Compare Source](https://togithub.com/github/codeql-action/compare/v2.21.1...v2.21.2) ### [`v2.21.1`](https://togithub.com/github/codeql-action/compare/v2.21.0...v2.21.1) [Compare Source](https://togithub.com/github/codeql-action/compare/v2.21.0...v2.21.1) </details> <details> <summary>gradle/gradle-build-action (gradle/gradle-build-action)</summary> ### [`v2.7.0`](https://togithub.com/gradle/gradle-build-action/releases/tag/v2.7.0) [Compare Source](https://togithub.com/gradle/gradle-build-action/compare/v2.6.1...v2.7.0) ##### GitHub Dependency Graph support In this release, the GitHub Dependency Graph support is no longer considered "experimental", and should be considered ready for production use. You can read more about the Dependency Graph support in [the README chapter](https://togithub.com/gradle/gradle-build-action#github-dependency-graph-support). ##### Changes - Update to [`github-dependency-graph-gradle-plugin@v0.2.0`](https://plugins.gradle.org/plugin/org.gradle.github-dependency-graph-gradle-plugin/0.2.0) - Dependency graph uses Gradle Settings file as manifest location (if Settings file exists) - Adds a `dependency-graph-file` output to any step that generates a Dependency Graph file ##### Changelog </details> --- ### Configuration 📅 **Schedule**: Branch creation - "every weekend" (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/slsa-framework/slsa-github-generator).  --------- Signed-off-by: Mend Renovate <bot@renovateapp.com> Signed-off-by: Ian Lewis <ianlewis@google.com> Co-authored-by: Ian Lewis <ianlewis@google.com> Signed-off-by: Noah Elzner <elzner@google.com>

* Add versions properties to cache * lint fix npm run format change * [FIX] unit test * docs: fix typo in the Readme.md * docs: update link to the toolkit/cache package --------- Co-authored-by: Ivan Zosimov <ivan.zosimov@Ivans-MacBook-Pro.local>

Add versions properties to cache

8a9565d

lint fix

0107059

npm run format change

[FIX] unit test

7cc9315

dsame approved these changes Jun 29, 2022

View reviewed changes

IvanZosimov self-requested a review July 20, 2023 07:59

IvanZosimov self-assigned this Jul 20, 2023

Merge branch 'main' into include-versions.properties-in-cache-key

450ead1

IvanZosimov requested a review from a team as a code owner July 20, 2023 10:29

IvanZosimov removed their request for review July 20, 2023 10:30

docs: fix typo in the Readme.md

925f9ff

IvanZosimov requested a review from dsame July 20, 2023 12:12

IvanZosimov approved these changes Jul 20, 2023

View reviewed changes

dsame approved these changes Jul 20, 2023

View reviewed changes

dmitry-shibanov approved these changes Jul 20, 2023

View reviewed changes

marko-zivic-93 approved these changes Jul 20, 2023

View reviewed changes

MaksimZhukov approved these changes Jul 21, 2023

View reviewed changes

docs: update link to the toolkit/cache package

8f98080

IvanZosimov merged commit cd89f46 into actions:main Jul 21, 2023

Add versions properties to cache by Endi327 · Pull Request #280 · actions/setup-java · GitHub

Uh oh!

Add versions properties to cache - #280

Add versions properties to cache#280
IvanZosimov merged 6 commits into
actions:mainfrom
Endi327:include-versions.properties-in-cache-key

Endi327 commented Jan 17, 2022 •
edited
Loading

Uh oh!

Uh oh!

dmitry-shibanov commented Jan 19, 2022

Uh oh!

Endi327 commented Jan 20, 2022 •
edited
Loading

Uh oh!

Uh oh!

dmitry-shibanov commented Jan 24, 2022 •
edited
Loading

Uh oh!

Uh oh!

dmitry-shibanov commented Jan 24, 2022

Uh oh!

Endi327 commented Jan 24, 2022 •
edited
Loading

Uh oh!

Uh oh!

Endi327 commented Jan 28, 2022

Uh oh!

Endi327 commented Apr 6, 2022

Uh oh!

dmitry-shibanov commented Jul 4, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Add versions properties to cache by Endi327 · Pull Request #280 · actions/setup-java · GitHub

Uh oh!

Add versions properties to cache - #280

Add versions properties to cache#280IvanZosimov merged 6 commits intoactions:mainactions/setup-java:mainfrom Endi327:include-versions.properties-in-cache-keyEndi327/setup-java:include-versions.properties-in-cache-keyCopy head branch name to clipboard

Conversation

Endi327 commented Jan 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dmitry-shibanov commented Jan 19, 2022

Uh oh!

Endi327 commented Jan 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dmitry-shibanov commented Jan 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dmitry-shibanov commented Jan 24, 2022

Uh oh!

Endi327 commented Jan 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Endi327 commented Jan 28, 2022

Uh oh!

Endi327 commented Apr 6, 2022

Uh oh!

dmitry-shibanov commented Jul 4, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Add versions properties to cache#280
IvanZosimov merged 6 commits into
actions:mainfrom
Endi327:include-versions.properties-in-cache-key

Endi327 commented Jan 17, 2022 •
edited
Loading

Endi327 commented Jan 20, 2022 •
edited
Loading

dmitry-shibanov commented Jan 24, 2022 •
edited
Loading

Endi327 commented Jan 24, 2022 •
edited
Loading