Document Java package compatibility by distribution - #1152
Merged
brunoborges merged 1 commit intoJul 28, 2026
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: de5ff500-7ba1-4b07-9805-cfc4036d6155
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a centralized reference in the advanced usage documentation to help users choose a compatible java-package for each supported Java distribution, including package suffix meaning, version constraints, catalog behavior, and platform limitations.
Changes:
- Added a new “Package compatibility” section with a distribution-by-distribution matrix of supported java-package values and constraints.
- Documented package suffix semantics (+fx, +crac, +jmods, +jcef, +ft) and clarified how setup-java resolves packages when version ranges aren’t explicitly constrained.
- Updated the example under “Installing custom Java package type” to demonstrate selecting a non-default package (jre) with a concrete distribution/version.
| File | Description |
|---|---|
| docs/advanced-usage.md | Adds a centralized “Package compatibility” matrix and supporting explanations for java-package selection across distributions. |
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: 0
- Review effort level: Low
Sorry, something went wrong.
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 supported java-package values and their version boundaries were scattered across distribution-specific examples and implementation details, making it difficult to choose a compatible artifact.
Add a central compatibility reference that explains package suffixes and maps every supported distribution to its package types, Java version constraints, catalog behavior, and notable platform limitations. The guidance also covers special resolution behavior for Temurin JMODs, Zulu CRaC, JavaFX bundles, JetBrains variants, and local jdkfile archives.
Related issue:
N/A
Check list: