ci: add checkstyle to workflows (#161)

Author: matthewelwell

.github/workflows/codeql.yml

@@ -1,4 +1,4 @@
-name: "Analyze and test"
+name: "Analyze"
 
 on:
   push:
@@ -9,8 +9,8 @@ on:
     - cron: '0 0 * * 4'
 
 jobs:
-  analyze_and_test:
-    name: Analyze and test
+  analyze:
+    name: Analyze
     runs-on: ubuntu-latest
 
     strategy:

.github/workflows/run-tests.yml

@@ -35,4 +35,4 @@ jobs:
           restore-keys: ${{ runner.os }}-m2
 
       - name: Build with Maven
-        run: mvn -B test
+        run: mvn clean install

checkstyle-suppressions.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+
+<!DOCTYPE suppressions PUBLIC
+        "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
+        "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+
+<suppressions>
+    <suppress checks="MissingJavadocType" files=".*\.java" />
+    <suppress checks="AbbreviationAsWordInName" files="Hashing.java|IOfflineHandler.java" />
+    <suppress checks="MemberName" files="SegmentConditionModel.java" />
+</suppressions>

google_checks_v8.19.xml

@@ -44,7 +44,7 @@
     <jacksonVersion>2.15.2</jacksonVersion>
     <lombok.version>1.18.34</lombok.version>
     <slf4j.version>1.7.30</slf4j.version>
-    <maven.checkstyle.version>3.1.0</maven.checkstyle.version>
+    <maven.checkstyle.version>3.4.0</maven.checkstyle.version>
     <junit.jupiter.version>5.9.2</junit.jupiter.version>
   </properties>
 
@@ -227,11 +227,11 @@
         <artifactId>maven-checkstyle-plugin</artifactId>
         <version>${maven.checkstyle.version}</version>
         <configuration>
-          <configLocation>google_checks_v8.19.xml</configLocation>
-          <encoding>UTF-8</encoding>
+          <configLocation>google_checks.xml</configLocation>
+          <suppressionsLocation>checkstyle-suppressions.xml</suppressionsLocation>
           <consoleOutput>true</consoleOutput>
           <failsOnError>true</failsOnError>
-          <linkXRef>false</linkXRef>
+          <linkXRef>true</linkXRef>
           <violationSeverity>warning</violationSeverity>
         </configuration>
         <executions>
@@ -269,9 +269,6 @@
                 </goals>
               </execution>
             </executions>
-            <configuration>
-              <doclint>all,-missing</doclint>
-            </configuration>
           </plugin>
           <plugin>
             <groupId>org.apache.maven.plugins</groupId>

pom.xml

@@ -64,6 +64,7 @@ public FlagsmithApiWrapper(
 
   /**
    * Instantiate with config, custom headers, logger and apikey.
+   *
    * @param defaultConfig config object
    * @param customHeaders custom headers list
    * @param logger logger instance
@@ -88,6 +89,7 @@ public FlagsmithApiWrapper(
 
   /**
    * Instantiate with config, custom headers, logger, apikey and request processor.
+   *
    * @param defaultConfig config object
    * @param customHeaders custom headers list
    * @param logger logger instance
@@ -112,7 +114,6 @@ public FlagsmithApiWrapper(
    * Get Feature Flags from API.
    *
    * @param doThrow - whether throw exception or not
-   * @return
    */
   public Flags getFeatureFlags(boolean doThrow) {
     Flags featureFlags = new Flags();
@@ -302,8 +303,8 @@ private Request.Builder newRequestBuilder() {
 
   /**
    * Returns a build request with GET.
+   *
    * @param url - URL to invoke
-   * @return
    */
   @Override
   public Request newGetRequest(HttpUrl url) {
@@ -315,9 +316,9 @@ public Request newGetRequest(HttpUrl url) {
 
   /**
    * Returns a build request with GET.
+   *
    * @param url - URL to invoke
    * @param body - body to post
-   * @return
    */
   @Override
   public Request newPostRequest(HttpUrl url, RequestBody body) {