From 29270b88a4c98afb2b73b95b7e1a49cb9e072520 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Luk=C3=A1=C5=A1=20Kr=C3=A1l?=
 <53821852+im-konge@users.noreply.github.com>
Date: Tue, 5 Mar 2024 10:24:46 +0100
Subject: [PATCH] Add spotbugs check to the project and build pipeline (#28)

Signed-off-by: Lukas Kral <lukywill16@gmail.com>
---
 .github/workflows/build.yaml |  3 +++
 pom.xml                      | 26 +++++++++++++++++++++++---
 2 files changed, 26 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
index 47e1e05..a8fcb41 100644
--- a/.github/workflows/build.yaml
+++ b/.github/workflows/build.yaml
@@ -25,3 +25,6 @@ jobs:
 
       - name: Build
         run: mvn --batch-mode install
+
+      - name: Run spotbugs check
+        run: mvn spotbugs:spotbugs
\ No newline at end of file
diff --git a/pom.xml b/pom.xml
index f07bff6..19c5c4a 100644
--- a/pom.xml
+++ b/pom.xml
@@ -77,11 +77,11 @@
         <fabric8.version>6.10.0</fabric8.version>
         <logback.version>1.4.12</logback.version>
 
+        <!--   Build tools' properties     -->
+        <spotbugs.version>4.7.3</spotbugs.version>
         <maven.spotbugs.version>4.7.3.4</maven.spotbugs.version>
         <maven.checkstyle.version>3.3.0</maven.checkstyle.version>
-        <maven.compiler.source>17</maven.compiler.source>
-        <maven.compiler.target>17</maven.compiler.target>
-        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+
         <maven.source.plugin.version>3.3.0</maven.source.plugin.version>
         <maven.deploy.plugin.version>3.1.1</maven.deploy.plugin.version>
         <maven.gpg.version>3.1.0</maven.gpg.version>
@@ -184,6 +184,26 @@
 
     <build>
         <plugins>
+            <plugin>
+                <groupId>com.github.spotbugs</groupId>
+                <artifactId>spotbugs-maven-plugin</artifactId>
+                <version>${maven.spotbugs.version}</version><dependencies>
+                <!-- overwrite dependency on spotbugs if you want to specify the version of˓→spotbugs -->
+                <dependency>
+                    <groupId>com.github.spotbugs</groupId>
+                    <artifactId>spotbugs</artifactId>
+                    <version>${spotbugs.version}</version>
+                </dependency></dependencies>
+                <configuration>
+                    <effort>Max</effort>
+                    <!-- Reports all bugs (other values are medium and max) -->
+                    <threshold>Low</threshold>
+                    <!-- Produces XML report -->
+                    <xmlOutput>true</xmlOutput>
+                    <!-- Configures the directory in which the XML report is created -->
+                    <spotbugsXmlOutputDirectory>${project.build.directory}/spotbugs</spotbugsXmlOutputDirectory>
+                </configuration>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>