diff --git a/README.md b/README.md index 5901ebb..97512bd 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ Example Maven Project for a JavaFX Application. +**Update**: Added reporting to create a site (html documentation of project) + **Update**: Java 21 is now fully supported This projects includes multiple plugins: diff --git a/documentation/de/QuickStart.md b/documentation/de/QuickStart.md index 1cc95cf..5a0d069 100644 --- a/documentation/de/QuickStart.md +++ b/documentation/de/QuickStart.md @@ -27,7 +27,7 @@ aufrufen. Um die Anwendung zu übersetzen kannst Du aufrufen: ```./mvnw package``` -### Bau des Images zur weitergabe +### Bau des Images zur Weitergabe Um das Image zu bauen, rufst du einfach Maven mit dem Profil Image und dem Ziel install auf: @@ -37,9 +37,21 @@ Ziel install auf: da dieses Plugin zwingend eine Modulbeschreibung für das Projekt und alle Abhängigkeiten erfordert. +### Komplette Übersetzung des Projekts incl. Dokumentation +Mit dem folgenden Befehl lässt sich das ganze Projekt von grundauf neu übersetzen incl. +der Erstellung der HTML Dokumentation des Projektes: +```./mvnw -Dimage clean install site``` + +- **-Dimage** aktiviert das Profil image, das für den Bau des Application Images zuständig ist +- **clean** Mit dem Ziel clean wird am Anfang alles, was bereits ggf. schon an Übersetzungen vorhanden ist, entfernt wird. +- **install** Durch install wird das ganze Projekt gebaut incl. Unit Tests, statischer Codeanalyse, ... +- **site** Es wird die Dokumentation des Projektes gebaut. + ## Ergebnisse der statischen Codeanalyse Die Codeanalyse läuft automatisch beim Bau des Projektes und die Ergebnisse finden sich in: - ./target/pmd.xml - ./target/spotbugsXml.xml + +Wenn die Site gebau wird, dann gibt es html Seiten mit den Ergebnissen von PMD und Spotbugs in der Site. \ No newline at end of file diff --git a/documentation/de/_Index.md b/documentation/de/_Index.md index 7a20fb4..b1d7c2f 100644 --- a/documentation/de/_Index.md +++ b/documentation/de/_Index.md @@ -12,4 +12,5 @@ - [SpotBugs](SpotBugs.md) ## Sonstiges +- Reporting - Lombok \ No newline at end of file diff --git a/documentation/en/QuickStart.md b/documentation/en/QuickStart.md index 6d20fb5..0decbea 100644 --- a/documentation/en/QuickStart.md +++ b/documentation/en/QuickStart.md @@ -33,6 +33,15 @@ To build the image, the profile Image must be used: **Important** You cannot build an image using the javafx plugin. The javafx plugin requires that you build a modular Java application and all dependencies providing a module description. +### complete build including documentation +To build the complete project from scratch and build all parts possible, you could use the following command: +```./mvnw -Dimage clean install site``` + +- **-Dimage** activates the profile image that is responsible to build the application image +- **clean** cleans everything of previous builds. +- **install** build the project (compile, build jar file, ...) +- **site** creates the html documentation of the project + ## Static code analysis results The static code analysis is done during the build of the application. The results can be found in diff --git a/documentation/en/_Index.md b/documentation/en/_Index.md index 6a69840..cfd09a4 100644 --- a/documentation/en/_Index.md +++ b/documentation/en/_Index.md @@ -12,4 +12,5 @@ - [SpotBugs](SpotBugs.md) ## Other Topics +- Reporting - Lombok \ No newline at end of file diff --git a/pom.xml b/pom.xml index 902c6f3..1d7b63a 100644 --- a/pom.xml +++ b/pom.xml @@ -30,6 +30,9 @@ 5.11.0 + 2.16.2 + 0.0.8 + 0.1.5 3.3.2 3.13.0 3.6.1 @@ -37,14 +40,13 @@ 3.4.1 3.1.2 3.4.1 + 3.6.3 + 3.5.0 3.3.1 - 4.0.0-M13 + 4.0.0-M14 3.2.5 1.0.0.RC2 - 0.1.5 - 3.22.0 - 2.16.2 - 0.0.8 + 3.22.0 4.8.5.0 4.8.5 @@ -237,7 +239,7 @@ org.apache.maven.plugins maven-pmd-plugin - ${maven.pmd.version} + ${maven.pmd.plugin} 100 ${java.version} @@ -272,6 +274,20 @@ + + org.apache.maven.plugins + maven-javadoc-plugin + ${maven.javadoc.plugin} + + + attach-javadocs + + jar + + + + + org.openjfx @@ -284,6 +300,71 @@ + + + + org.apache.maven.plugins + maven-project-info-reports-plugin + ${maven.project.info.reports.plugin} + + + + index + dependencies + licenses + summary + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + ${maven.javadoc.plugin} + + + + javadoc + + + + tests + + private + + + test-javadoc + + + + + + org.apache.maven.plugins + maven-pmd-plugin + ${maven.pmd.plugin} + + + + pmd + + + + + + com.github.spotbugs + spotbugs-maven-plugin + ${spotbugs.maven.plugin} + + + + spotbugs + + + + + + +