feat: java support for jdk17 (#1952)

Author: davidgamez

.github/workflows/acceptance_test.yml

@@ -22,8 +22,8 @@ concurrency:
 
 env:
   python_version: '3.11'
-  java_version: '11'
-  java_distribution: 'temurin'
+  java_version: '17'
+  java_distribution: 'zulu'
 
 jobs:
   fail_if_pull_request_is_draft: # Fails in order to indicate that pull request needs to be marked as ready to review to pass.

.github/workflows/docker.yml

@@ -7,8 +7,8 @@ on:
     types: [ prereleased, released ]
 
 env:
-  java_version: '11'
-  java_distribution: 'temurin'
+  java_version: '17'
+  java_distribution: 'zulu'
 
 jobs:
   validate_gradle_wrapper:

.github/workflows/end_to_end.yml

@@ -35,8 +35,8 @@ on:
 
 env:
   python_version: '3.11'
-  java_version: '11'
-  java_distribution: 'temurin'
+  java_version: '17'
+  java_distribution: 'zulu'
 
 jobs:
   validate_gradle_wrapper:

.github/workflows/formatting.yml

@@ -8,8 +8,8 @@ on:
       - '.github/workflows/**'
 
 env:
-  java_version: '11'
-  java_distribution: 'temurin'
+  java_version: '17'
+  java_distribution: 'zulu'
 
 jobs:
   formatting:
@@ -21,25 +21,55 @@ jobs:
         with:
           java-version: ${{ env.java_version }}
           distribution: ${{ env.java_distribution }}
+
       - name: Cache Gradle packages
         uses: actions/cache@v3
         with:
           path: ~/.gradle/caches
           key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle') }}
           restore-keys: ${{ runner.os }}-gradle
-      - name: Check code compliance to google java format standards
-        uses: gradle/gradle-build-action@v2
+
+      - name: Run Spotless Check
+        run: |
+          ./gradlew spotlessCheck --quiet --continue 2>&1 | tee spotless-output.txt
+          if grep -q "\.java" spotless-output.txt; then
+            exit 1
+          fi
+
+      - name: Upload Spotless Output
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@v4
         with:
-          arguments: verGJF
+          name: spotless-output
+          path: spotless-output.txt
+
+      - name: Extract Affected Files
+        if: ${{ failure() }}
+        run: |
+          grep "\.java" spotless-output.txt > affected-files.txt || true
+
       - name: Comment PR if code does not comply to Google Java style guide
         if: ${{ failure() }}
         uses: actions/github-script@v6
         with:
-          github-token: ${{secrets.GITHUB_TOKEN}}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
+            const fs = require('fs');
+            const files = fs.existsSync('affected-files.txt') ? fs.readFileSync('affected-files.txt', 'utf8').trim().split('\n') : [];
+            if (files.length === 0) return;
+
+            const actionsDashboardUrl = `https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}`;
+
+            const commentBody = `### 🚨 Code Formatting Issue 🚨\n\n`
+              + `This contribution does not follow the conventions set by the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html).\n\n`
+              + `Please run the following command at the root of the project to fix formatting errors:\n\n`
+              + "```sh\n./gradlew spotlessApply\n```\n\n"
+              + `<details><summary><strong>🗂️ Affected files</strong></summary>\n\n${files.map(file => `- \`${file.trim()}\``).join('\n')}</details>\n\n`
+              + `[Go to the Actions Dashboard to download the full Spotless output](${actionsDashboardUrl})\n\n`;
+
             github.rest.issues.createComment({
               issue_number: context.issue.number,
               owner: context.repo.owner,
               repo: context.repo.repo,
-              body: "This contribution does not follow the conventions set by the [Google Java style guide](https://google.github.io/styleguide/javaguide.html). Please run the following command line at the root of the project to fix formatting errors: ```./gradlew goJF```."
-            })
+              body: commentBody
+            });

.github/workflows/package_installers.yml

@@ -27,7 +27,7 @@ env:
   MACOS_NOTARIZATION_APPLE_ID: ${{ secrets.MACOS_NOTARIZATION_USERNAME }}
   MACOS_NOTARIZATION_TEAM_ID: ${{ secrets.MACOS_NOTARIZATION_TEAM_ID }}
   MACOS_NOTARIZATION_PWD: ${{ secrets.MACOS_NOTARIZATION_PASSWORD }}
-  java_version: '17.0'
+  java_version: '17'
   java_distribution: 'zulu'
 
 jobs:

.github/workflows/publish_assets.yml

@@ -6,7 +6,7 @@ on:
   workflow_dispatch:
 
 env:
-  java_version: '17.0'
+  java_version: '17'
   java_distribution: 'zulu'
 
 jobs:
@@ -101,7 +101,6 @@ jobs:
 
       - name: Build and Publish to Sonatype
         run: |
-          # The gradle java verifying plugin does not work with java 17.
           # Don't verify since it has already been done when the PR was created.
-          ./gradlew publish --rerun-tasks -x verifyGoogleJavaFormat
+          ./gradlew publish --rerun-tasks -x spotlessCheck
 

.github/workflows/stg_web_client_merge.yml

@@ -8,7 +8,7 @@ on:
 
 env:
   NODE_VERSION: "20"
-  java_version: '17.0'
+  java_version: '17'
   java_distribution: 'zulu'
 
 jobs:

.github/workflows/stg_web_svc_merge.yml

@@ -8,7 +8,7 @@ on:
 
 env:
   NODE_VERSION: "20"
-  java_version: '17.0'
+  java_version: '17'
   java_distribution: 'zulu'
 
 jobs:

.github/workflows/test_pack_doc.yml

@@ -19,15 +19,15 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        java_version: [ 11, 17 ]
+        java_version: [ '17' ]
         os: [ ubuntu-latest, windows-latest ]
     steps:
       - uses: actions/checkout@v3
       - name: Set up JDK ${{ matrix.java_version }}
         uses: actions/setup-java@v3
         with:
           java-version: ${{ matrix.java_version }}
-          distribution: 'temurin'
+          distribution: 'zulu'
       - name: Cache Gradle packages
         uses: actions/cache@v3
         with:
@@ -37,7 +37,6 @@ jobs:
       - name: Run tests on Java ${{ matrix.java_version }} and ${{ matrix.os }}
         uses: gradle/gradle-build-action@v2
         with:
-          # We run test aggregation with --continue to make sure all tests run, even if some fail.
           arguments: testAggregateTestReport --continue
       - name: Persist aggregated test reports on failure - Java ${{ matrix.java_version }} on ${{ matrix.os }}
         if: ${{ failure() }}
@@ -51,15 +50,15 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        java_version: [ 11, 17 ]
+        java_version: [ '17' ]
         os: [ ubuntu-latest, windows-latest ]
     steps:
       - uses: actions/checkout@v3
       - name: Set up JDK ${{ matrix.java_version }}
         uses: actions/setup-java@v3
         with:
           java-version: ${{ matrix.java_version }}
-          distribution: 'temurin'
+          distribution: 'zulu'
       - name: Cache Gradle packages
         uses: actions/cache@v3
         with:
@@ -75,20 +74,21 @@ jobs:
         with:
           name: Application - CLI executable - Java ${{ matrix.java_version }} JAR file -- ${{ matrix.os }}
           path: cli/build/libs/gtfs-validator-*-cli.jar
+
   doc:
     needs: [test]
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        java_version: [ 11, 17 ]
+        java_version: [ '17' ]
         os: [ ubuntu-latest, windows-latest ]
     steps:
       - uses: actions/checkout@v3
       - name: Set up JDK ${{ matrix.java_version }}
         uses: actions/setup-java@v3
         with:
           java-version: ${{ matrix.java_version }}
-          distribution: 'temurin'
+          distribution: 'zulu'
       - name: Cache Gradle packages
         uses: actions/cache@v3
         with:
@@ -102,5 +102,5 @@ jobs:
       - name: Persist javadoc
         uses: actions/upload-artifact@v4
         with:
-          name: Documentation - javadoc - Java ${{ matrix.java_version }} - ${{ matrix.java_version }}
-          path: build/docs/javadoc/
+          name: Documentation - javadoc - Java ${{ matrix.java_version }} - ${{ matrix.os }}
+          path: build/docs/javadoc/

.github/workflows/web_client_pr.yml

@@ -10,7 +10,7 @@ on:
 
 env:
   NODE_VERSION: "20"
-  java_version: '17.0'
+  java_version: '17'
   java_distribution: 'zulu'
 
 jobs: