Updates the sbt cache docs in the README#327
Merged
dmitry-shibanov merged 1 commit intoactions:mainfrom May 9, 2022
adamnfish:update-sbt-cache-docs
Merged
Updates the sbt cache docs in the README#327dmitry-shibanov merged 1 commit intoactions:mainfrom adamnfish:update-sbt-cache-docs
dmitry-shibanov merged 1 commit intoactions:mainfrom
adamnfish:update-sbt-cache-docs
Conversation
The README's description of sbt's cache behaviour does not match the implementation. An `sbt` build can be modified from multiple places and the current cache invalidation behaviour correctly captures these cases. The README only mentions `build.sbt` files, which might mean teams with more experience using `sbt` unnecessarily add their own cache patterns here. Here's the (current) implementation, for reference: https://github.com/actions/setup-java/blob/860f60056505705214d223b91ed7a30f173f6142/src/cache.ts#L43
fmeriaux
approved these changes
May 7, 2022
Contributor
fmeriaux
left a comment
fmeriaux
left a comment
There was a problem hiding this comment.
LGTM 👍
Good point, I had forgotten to edit this section in my contribution.
marko-zivic-93
approved these changes
May 9, 2022
dmitry-shibanov
approved these changes
May 9, 2022
tdfacer
pushed a commit
to ifit/setup-java
that referenced
this pull request
Oct 7, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description:
The README's description of sbt's cache behaviour does not match the implementation. An
sbtbuild can be modified from multiple places and the current cache invalidation behaviour correctly captures these cases. The README only mentionsbuild.sbtfiles, which might mean teams with more experience usingsbtunnecessarily add their own cache patterns here.Here's the (current) implementation, for reference:
setup-java/src/cache.ts
Line 43 in 860f600
Related issue:
N/A
Check list: