Clarify README version syntax and migration guidance#1038
Merged
Conversation
Copilot
AI
changed the title
[WIP] Update README to clarify version details
Clarify README version syntax and migration guidance
Jun 22, 2026
brunoborges
approved these changes
Jun 22, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the actions/setup-java README to reduce confusion around supported java-version values and to place V1→V2 migration guidance in a more appropriate spot, aligning the docs with the action’s current major version (v5) while keeping the historical breaking-change note relevant.
Changes:
- Clarifies that the listed
java-versionvalues are illustrative examples, not an exhaustive supported set. - Rewords the “major versions” bullet to emphasize example syntax rather than a fixed list.
- Moves the “V2 vs V1” section later in the README and clarifies that the V1→V2 behavior change still applies to later majors (
v3–v5).
Show a summary per file
| File | Description |
|---|---|
| README.md | Clarifies java-version example syntax and relocates/updates V1→V2 migration guidance for readers using actions/setup-java@v5. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 0
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:
The README could be read as if only a small fixed set of Java major versions were supported, and its version-migration note referenced only V1 vs V2 despite later examples using newer action majors.
Version syntax clarification
java-versionvalues are examples, not an exhaustive list.Migration guidance placement
V2 vs V1section later in the README, after the main usage guidance.actions/setup-java@v5, the key V1→V2 behavioral change still applies to later majors (v3-v5).Example
Related issue:
#481
Check list: