Skip to content

Commit

Permalink
Use openjfx 17 by default
Browse files Browse the repository at this point in the history
Fixes #54
  • Loading branch information
adangel committed Mar 7, 2024
1 parent 2af460d commit be13091
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 4 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,17 @@ The maven coordinates (GAV) have been changed. The artifactId has been renamed t

At the same time, the release artefact name changed to **pmd-designer-7.0.0.jar**.

**Changed default OpenJFX version to be 17**

The designer is built now against openjfx 17. When using the designer with OpenJDK, at least Java 11
is required with openjfx 17 or later.

The designer can still be started with Oracle's Java 8, which includes JavaFX. But this is not
explicitly tested.

**Fixed issues:**

* [#54](https://github.com/pmd/pmd-designer/issues/54) Upgrade openjfx to 17
* [#65](https://github.com/pmd/pmd-designer/issues/65) Rename artifactId to pmd-designer

**Merged pull requests:**
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ rules. Main features:
The designer is part of PMD's binary distributions. To install a distribution, see the
[documentation page](https://docs.pmd-code.org/latest/pmd_userdocs_installation.html) about installing PMD.

The app needs JRE 1.8 or above to run. Be aware that on JRE 11+, the JavaFX distribution should be installed
separately. Visit [the download page](https://gluonhq.com/products/javafx/) to download a distribution,
The app needs either Oracle Java 8 (which includes JavaFX) or OpenJDK 11+ and a separately installed
OpenJFX distribution. Visit [JavaFX - Gluon](https://gluonhq.com/products/javafx/) to download an SDK distribution,
extract it, and set the `JAVAFX_HOME` environment variable.

If the `bin` directory of your PMD distribution is on your shell's path, then you can **launch the app** with
Expand All @@ -32,7 +32,7 @@ If the `bin` directory of your PMD distribution is on your shell's path, then yo
Alternatively, you can launch the program "from source" with Maven.
* `$ ./mvnw -Prunning exec:java` will launch the program after compiling it, using the JavaFX distribution of your system
* `$ ./mvnw -Prunning,with-javafx exec:java` will also add JavaFX dependencies on your classpath.
You can change the version of those dependencies with eg `-Dopenjfx.version=13` for OpenJFX 13.
You can change the version of those dependencies with eg `-Dopenjfx.version=21.0.2` for OpenJFX 21.
See the list of available versions [here](https://search.maven.org/artifact/org.openjfx/javafx).

### Updating
Expand Down Expand Up @@ -62,6 +62,7 @@ The `pmd.core.version` property selects the version of pmd-core *and pmd-java*
that will be included. The built jar can then be found in your `target` directory.
**Such a jar cannot be used in a PMD distribution** and must be used in a
standalone fashion, otherwise classpath conflicts may arise.
You can additionally enable the profile `with-javafx` to include openjfx as well.

You should never run the `install` goal with the `-Dfat-java` property! This
would install the fat jar in your local repo and may cause dependency conflicts.
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
<pmd.designer.version>${project.version}</pmd.designer.version> <!-- see DesignerVersion -->
<pmd.core.version>7.0.0-SNAPSHOT</pmd.core.version>

<openjfx.version>11.0.2</openjfx.version>
<openjfx.version>17.0.10</openjfx.version>
<java.version>8</java.version>
<kotlin.version>1.7.20</kotlin.version>
<kotest.version>5.5.5</kotest.version>
Expand Down

0 comments on commit be13091

Please sign in to comment.