From f3527f9f995abebb228fa0e98733cb1c7f290a8c Mon Sep 17 00:00:00 2001
From: Konrad Neitzel <konrad@kneitzel.de>
Date: Wed, 10 Jan 2024 18:38:54 +0100
Subject: [PATCH] Added reporting to maven project, added creation of source
 and javadoc jar files.

---
 pom.xml | 142 +++++++++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 119 insertions(+), 23 deletions(-)

diff --git a/pom.xml b/pom.xml
index aab65ec..96eb5d6 100644
--- a/pom.xml
+++ b/pom.xml
@@ -30,36 +30,40 @@
         <required.maven.version>3.6.3</required.maven.version>
 
         <!-- Dependency versions -->
-        <jetbrains.annotations.version>24.0.1</jetbrains.annotations.version>
-        <junit.version>5.9.3</junit.version>
-        <lombok.version>1.18.26</lombok.version>
-        <mockito.version>5.3.1</mockito.version>
+        <jetbrains.annotations.version>24.1.0</jetbrains.annotations.version>
+        <junit.version>5.10.1</junit.version>
+        <lombok.version>1.18.30</lombok.version>
+        <mockito.version>5.8.0</mockito.version>
         <pmd.version>6.55.0</pmd.version>
-        <spotbugs.version>4.7.3</spotbugs.version>
+        <spotbugs.version>4.8.3</spotbugs.version>
 
         <!-- Plugin dependencies -->
-        <codehaus.version.plugin>2.11.0</codehaus.version.plugin>
+        <codehaus.version.plugin>2.16.2</codehaus.version.plugin>
         <jpackage.maven.plugin>0.1.3</jpackage.maven.plugin>
-        <maven.clean.plugin>3.2.0</maven.clean.plugin>
-        <maven.compiler.plugin>3.10.1</maven.compiler.plugin>
-        <maven.dependency.plugin>3.3.0</maven.dependency.plugin>
-        <maven.deploy.plugin>3.0.0-M2</maven.deploy.plugin>
-        <maven.enforcer.plugin>3.1.0</maven.enforcer.plugin>
-        <maven.install.plugin>3.0.0-M1</maven.install.plugin>
-        <maven.jar.plugin>3.2.2</maven.jar.plugin>
-        <maven.pmd.plugin>3.16.0</maven.pmd.plugin>
-        <maven.resources.plugin>3.2.0</maven.resources.plugin>
-        <maven.site.plugin>4.0.0-M1</maven.site.plugin>
-        <maven.surfire.plugin>3.0.0-M6</maven.surfire.plugin>
+        <maven.clean.plugin>3.3.2</maven.clean.plugin>
+        <maven.compiler.plugin>3.12.1</maven.compiler.plugin>
+        <maven.dependency.plugin>3.6.1</maven.dependency.plugin>
+        <maven.deploy.plugin>3.1.1</maven.deploy.plugin>
+        <maven.enforcer.plugin>3.4.1</maven.enforcer.plugin>
+        <maven.install.plugin>3.1.1</maven.install.plugin>
+        <maven.jar.plugin>3.3.0</maven.jar.plugin>
+        <maven.javadoc.plugin>3.6.3</maven.javadoc.plugin>
+        <maven.pmd.plugin>3.21.2</maven.pmd.plugin>
+        <maven.project.info.reports.plugin>3.5.0</maven.project.info.reports.plugin>
+        <maven.resources.plugin>3.3.1</maven.resources.plugin>
+        <maven.site.plugin>4.0.0-M13</maven.site.plugin>
+        <maven.source.plugin>3.3.0</maven.source.plugin>
+        <maven.surfire.plugin>3.2.5</maven.surfire.plugin>
         <moditect.maven.plugin>1.0.0.RC2</moditect.maven.plugin>
-        <native.maven.plugin>0.9.17</native.maven.plugin>
-        <spotbugs.maven.plugin>4.7.2.0</spotbugs.maven.plugin>
-        
+        <native.maven.plugin>0.9.28</native.maven.plugin>
+        <spotbugs.maven.plugin>4.8.2.0</spotbugs.maven.plugin>
+
+
         <!-- other properties -->
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <maven.compiler.source>${java.version}</maven.compiler.source>
         <maven.compiler.target>${java.version}</maven.compiler.target>
-
+        <maven.compiler.release>${java.version}</maven.compiler.release>
     </properties>
 
     <dependencies>
@@ -300,9 +304,99 @@
                 <artifactId>maven-site-plugin</artifactId>
                 <version>${maven.site.plugin}</version>
             </plugin>
+
+            <!-- JavaDoc Plugin to create a jar with the JavaDoc -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>${maven.javadoc.plugin}</version>
+                <executions>
+                    <execution>
+                        <id>attach-javadocs</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+
+            <!-- Source Plugin to create a jar with the sources -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+                <version>${maven.source.plugin}</version>
+                <executions>
+                    <execution>
+                        <id>attach-sources</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+
         </plugins>
     </build>
 
+    <reporting>
+        <plugins>
+            <!-- Project Info Reports Plugin to generate the reports -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-project-info-reports-plugin</artifactId>
+                <version>${maven.project.info.reports.plugin}</version>
+                <reportSets>
+                    <reportSet>
+                        <reports>
+                            <report>index</report>
+                            <report>dependencies</report>
+                            <report>licenses</report>
+                            <report>summary</report>
+                        </reports>
+                    </reportSet>
+                </reportSets>
+            </plugin>
+
+            <!-- JavaDoc Plugin to include the JavaDoc inside the report -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>${maven.javadoc.plugin}</version>
+                <reportSets>
+                    <reportSet>
+                        <reports>
+                            <report>javadoc</report>
+                        </reports>
+                    </reportSet>
+                    <reportSet>
+                        <id>tests</id>
+                        <configuration>
+                            <show>private</show>
+                        </configuration>
+                        <reports>
+                            <report>test-javadoc</report>
+                        </reports>
+                    </reportSet>
+                </reportSets>
+            </plugin>
+
+            <!-- PMD Plugin to include the PMD report -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-pmd-plugin</artifactId>
+                <version>${maven.pmd.plugin}</version>
+                <reportSets>
+                    <reportSet>
+                        <reports>
+                            <report>pmd</report>
+                        </reports>
+                    </reportSet>
+                </reportSets>
+            </plugin>
+
+        </plugins>
+    </reporting>
+
     <profiles>
 
         <!-- Profile that adds compiling to a native binary using
@@ -319,6 +413,7 @@
             </activation>
             <build>
                 <plugins>
+                    <!-- Build the native binary -->
                     <plugin>
                         <groupId>org.graalvm.buildtools</groupId>
                         <artifactId>native-maven-plugin</artifactId>
@@ -368,7 +463,7 @@
                         <artifactId>maven-dependency-plugin</artifactId>
                         <version>${maven.dependency.plugin}</version>
                         <executions>
-                            <!-- erstmal Abhängigkeiten für den Class-Path kopieren -->
+                            <!-- copy dependencies for the classpath -->
                             <execution>
                                 <id>copy-dependencies</id>
                                 <phase>package</phase>
@@ -384,7 +479,7 @@
                                 </configuration>
                             </execution>
 
-                            <!-- dazu noch das Projekt-JAR -->
+                            <!-- Copy the project jar -->
                             <execution>
                                 <id>copy</id>
                                 <phase>install</phase>
@@ -408,6 +503,7 @@
                         </executions>
                     </plugin>
 
+                    <!-- Create the image -->
                     <plugin>
                         <groupId>com.github.akman</groupId>
                         <artifactId>jpackage-maven-plugin</artifactId>