Enforce minimum version (#84)

* - Add GitHub Action to trigger CheckStyle checks on non-master push

* - New Bash and Batch script for "dev_tools" (just CheckStyle functions now)
- Ignore "dev_tools" directory in .gitignore

* - Added Apache Maven CheckStyle plugin (run with `mvn verify`)

* Update .github/workflows/checkstyle.yml

Co-authored-by: Justin Hammond <[email protected]>

* - Remove dev_tools scripts, use Maven plugin instead for CheckStyle

* - Remove checkstyle.yml, roll functionality into existing CI Action

* - Update name of CheckStyle CI job

* - Added Maven Enforcer Plugin to enforce required Java version (via https://maven.apache.org/enforcer/enforcer-rules/requireJavaVersion.html)

* - Check Java 8 - 17 in CI Action
- Specifically use v0.4.0 of checkstyle-action

* - Bump Gson to 2.8.9, junit to 4.13.2
- Use CheckStyle 9.2.1 for Maven CheckStyle check
- Maven CheckStyle plugin will fail in Java 6/7 environment; if you want to develop for this library, you'll need to be running Java 8+

* - Explicitly support Java 6 - 17.0.1
- GitHub CI tests compatibility in Java 6 - 17

* add Java version to the User-Agent in requests (#83)

* - Tweak Maven Enforcer plugin to support 1.6.0+ (no explicit max)

* - Fix Java versions in GitHub CI

* - Remove Java 6 support for GitHub CI

* - Continue Java compatibility tests even if one fails

* Testing continue-on-error

* - Skip CheckStyle checks in compatibility check

* - Continue compatibility tests even if/when Java 7 fails because of CheckStyle plugin

* - Drop testing for Java 7, since it's always going to fail because of CheckStyle (causing other tests to abort early)

* - EasyPost explicitly supports Java 8+

* - Ignore TODO comments in CheckStyle
- Exclude EasyPost.java in CheckStyle checks
- Fail GitHub CI when CheckStyle errors are present

* - Enforce TODOs in Java files, ignore in all other types of files

Co-authored-by: Justin Hammond <[email protected]>
Co-authored-by: jchen293 <[email protected]>

Author: 3 people

.github/workflows/ci.yml

@@ -10,22 +10,24 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-          javaversion: ['8', '9', '10', '11']
+        javaversion: ['8', '9', '10', '11', '12', '13', '14', '15', '16', '17']
     steps:
       - uses: actions/checkout@v2
       - name: Set up Java ${{ matrix.javaversion }}
         uses: actions/setup-java@v1
         with:
           java-version: ${{ matrix.javaversion }}
       - name: Build with Maven
-        run: mvn --batch-mode install -Dgpg.skip=true -DskipTests=true
+        run: mvn --batch-mode install -Dgpg.skip=true -DskipTests=true -Dcheckstyle.skip=true
   lint:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - name: Run CheckStyle checks
         uses: nikitasavinov/[email protected]
         with:
+          level: error
+          fail_on_error: true
           checkstyle_config: easypost_java_style.xml
           tool_name: 'style_enforcer'
 

pom.xml

@@ -38,12 +38,12 @@
         <dependency>
             <groupId>com.google.code.gson</groupId>
             <artifactId>gson</artifactId>
-            <version>2.7</version>
+            <version>2.8.9</version>
         </dependency>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
-            <version>4.13.1</version>
+            <version>4.13.2</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -166,6 +166,13 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-checkstyle-plugin</artifactId>
                 <version>3.1.2</version>
+                <dependencies>
+                    <dependency>
+                        <groupId>com.puppycrawl.tools</groupId>
+                        <artifactId>checkstyle</artifactId>
+                        <version>9.2.1</version>
+                    </dependency>
+                </dependencies>
                 <executions>
                     <execution>
                         <id>validate</id>
@@ -182,6 +189,26 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-enforcer-plugin</artifactId>
+                <version>3.0.0</version>
+                <executions>
+                    <execution>
+                        <id>enforce-java</id>
+                        <goals>
+                            <goal>enforce</goal>
+                        </goals>
+                        <configuration>
+                            <rules>
+                                <requireJavaVersion>
+                                    <version>[1.8.0,)</version>
+                                </requireJavaVersion>
+                            </rules>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 </project>

style_suppressions.xml

@@ -5,10 +5,17 @@
         "https://checkstyle.org/dtds/suppressions_1_2.dtd">
 
 <suppressions>
+    <!-- TODO: Include Test files -->
     <!-- Don't do any CheckStyle checks on any Test files. -->
     <suppress checks="[a-zA-Z0-9]*"
               files="com[\\/]easypost[\\/].*Test.java"/>
     <!-- Don't do any CheckStyle checks on any com.easypost.app files. -->
     <suppress checks="[a-zA-Z0-9]*"
               files="com[\\/]easypost[\\/]app[\\/]"/>
+    <!-- Don't do any CheckStyle checks on com.easypost.EasyPost. -->
+    <suppress checks="[a-zA-Z0-9]*"
+              files="EasyPost.java"/>
+    <!-- Don't do any CheckStyle checks on any non-Java files. -->
+    <suppress files=".+\.(?:txt|xml|csv|sh|thrift|html|sql|eot|ttf|woff|css|png)$"
+              checks=".*"/>
 </suppressions>