docs: add JavaFX Maven project configuration instructions#1044
Merged
Conversation
Copilot
AI
changed the title
[WIP] Docs: Add config instructions for JavaFX Maven project
docs: add JavaFX Maven project configuration instructions
Jun 22, 2026
brunoborges
approved these changes
Jun 22, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds missing documentation for using actions/setup-java with JavaFX Maven projects by describing the supported java-package variants (jdk+fx / jre+fx) and providing Maven workflow snippets.
Changes:
- Added a new “JavaFX Maven project” subsection under “Installing custom Java package type”.
- Documented using
java-package: jdk+fxwith supported distributions (e.g.,zulu,liberica) and linked to OpenJFX Maven setup guidance. - Updated the table of contents to include the new subsection.
Show a summary per file
| File | Description |
|---|---|
| docs/advanced-usage.md | Adds a JavaFX+Maven documentation subsection, including example GitHub Actions steps and TOC entry. |
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: 3
| java-package: jdk+fx | ||
| cache: maven | ||
| - name: Build with Maven | ||
| run: mvn --no-transfer-progress compile |
|
|
||
| ```yaml | ||
| - name: Run with Maven | ||
| run: mvn --no-transfer-progress javafx:run |
| run: mvn --no-transfer-progress compile | ||
| ``` | ||
|
|
||
| To run the JavaFX application in CI: |
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.
No documentation existed for using
setup-javawith JavaFX Maven projects, despite the feature being supported viajava-package: jdk+fx.Changes:
### JavaFX Maven projectsubsection under## Installing custom Java package typeindocs/advanced-usage.mdjava-package: jdk+fx(orjre+fx) with supported distributions (zulu,liberica)pom.xmlsetupmvn compileandmvn javafx:runExample workflow snippet:
Related issue:
Closes #568
Check list: