docs: clarify Maven cache paths and key hash inputs - #1096
Merged
brunoborges merged 1 commit intoJul 9, 2026
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
Address post-merge review feedback on #1094: the intro paragraph described the cache too narrowly. setup-java caches both ~/.m2/repository and ~/.m2/wrapper/dists, and the default key hashes **/pom.xml plus .mvn/wrapper/maven-wrapper.properties and .mvn/extensions.xml, so changing wrapper/extensions files also invalidates the cache. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the advanced usage documentation to more accurately describe how cache: maven works in actions/setup-java, specifically what directories are cached and which files are hashed to produce the cache key.
Changes:
- Clarifies that cache: maven caches both ~/.m2/repository and Maven Wrapper distributions under ~/.m2/wrapper/dists.
- Clarifies that the default cache key includes hashes of **/pom.xml, **/.mvn/wrapper/maven-wrapper.properties, and **/.mvn/extensions.xml, and that modifying them invalidates the cache.
- Keeps the existing explanation that caches are only saved on cache miss runs (not re-saved on hits).
| File | Description |
|---|---|
| docs/advanced-usage.md | Updates the Maven cache completeness section to align with the action’s actual default cache paths and cache-key hash inputs. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Low
Sorry, something went wrong.
Comment thread
docs/advanced-usage.md
Comment on lines
+293
to
+296
| (`~/.m2/wrapper/dists`). The cache key is a hash of your Maven inputs — every | ||
| `**/pom.xml`, plus `**/.mvn/wrapper/maven-wrapper.properties` and | ||
| `**/.mvn/extensions.xml` — so changing any of those files (for example bumping | ||
| the wrapper version or editing core extensions) produces a new key and |
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
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:
Follow-up to post-merge review feedback on #1094. The intro paragraph of the "Ensuring the Maven cache is complete" section described the cache: maven behavior too narrowly, which could leave readers unsure why changing wrapper/extensions files invalidates the cache or why wrapper downloads are cached too.
Updated the paragraph to match what the action actually does (verified against src/cache.ts):
Docs-only change; no behavior changes.
Related issue:
Addresses review feedback: #1094 (comment)
Check list: