Merge remote-tracking branch 'origin/update-from-template' into develop

Author: AB-xdev

.config/checkstyle/checkstyle.xml

@@ -16,7 +16,7 @@
 	<module name="LineLength">
 		<property name="max" value="120"/>
 		<property name="fileExtensions" value="java"/>
-		<!-- Ignore default + links in comments -->
+		<!-- Ignore default + links -->
 		<property name="ignorePattern" value="(^(package|import))|(^\s*(\/\/|\*) .*https?.*$)"/>
 	</module>
 	<module name="NewlineAtEndOfFile"/>
@@ -30,10 +30,6 @@
 	</module>
 
 	<!-- Generated code -->
-	<module name="SuppressionSingleFilter">
-		<property name="checks" value="."/>
-		<property name="files" value="[\\/](src)?gen[\\/].*\.java$"/>
-	</module>
 	<module name="SuppressionSingleFilter">
 		<property name="checks" value="."/>
 		<property name="files" value="[\\/]src[\\/]gen(erated)?[\\/].*\.java$"/>
@@ -43,7 +39,15 @@
 		<property name="checks" value="MagicNumberCheck"/>
 		<property name="files" value="[\\/]test[\\/].*\.java$"/>
 	</module>
+
+	<!-- Suppressions -->
 	<module name="SuppressWarningsFilter"/>
+	<!-- https://github.com/checkstyle/checkstyle/issues/7287 -->
+	<module name="SuppressWithPlainTextCommentFilter">
+		<property name="offCommentFormat" value="// CHECKSTYLE\:OFF ([\w\|]+)"/>
+		<property name="onCommentFormat" value="// CHECKSTYLE\:ON ([\w\|]+)"/>
+		<property name="checkFormat" value="$1"/>
+	</module>
 
 	<module name="TreeWalker">
 		<!-- Checks - sorted alphabetically -->
@@ -131,11 +135,5 @@
 			<property name="tokens"
 					  value="ASSIGN,BAND,BAND_ASSIGN,BOR,BOR_ASSIGN,BSR,BSR_ASSIGN,BXOR,BXOR_ASSIGN,COLON,DIV,DIV_ASSIGN,EQUAL,GE,GT,LAND,LCURLY,LE,LOR,LT,MINUS,MINUS_ASSIGN,MOD,MOD_ASSIGN,NOT_EQUAL,PLUS,PLUS_ASSIGN,QUESTION,RCURLY,SL,SLIST,SL_ASSIGN,SR,SR_ASSIGN,STAR,STAR_ASSIGN,TYPE_EXTENSION_AND"/>
 		</module>
-
-		<!-- Filter -->
-		<module name="SuppressionCommentFilter">
-			<property name="offCommentFormat" value="\s*CHECKSTYLE:OFF\s*[^\s]{1,}"/>
-			<property name="onCommentFormat" value="\s*CHECKSTYLE:ON"/>
-		</module>
 	</module>
 </module>

.github/dependabot.yml

@@ -7,13 +7,15 @@ on:
     paths-ignore: 
       - '**.md'
       - '.config/**'
+      - '.github/**'
       - '.idea/**'
       - 'assets/**'
   pull_request:
     branches: [ develop ]
     paths-ignore: 
       - '**.md'
       - '.config/**'
+      - '.github/**'
       - '.idea/**'
       - 'assets/**'
 
@@ -40,7 +42,7 @@ jobs:
         cache: 'maven'
 
     - name: Build with Maven
-      run: mvn -B clean package
+      run: ./mvnw -B clean package
 
     - name: Check for uncommited changes
       run: |
@@ -56,12 +58,13 @@ jobs:
           echo ----------------------------------------
           echo Troubleshooting
           echo ----------------------------------------
-          echo "::error::Unstaged changes detected. Locally try running: git clean -ffdx && mvn -B clean package"
+          echo "::error::Unstaged changes detected. Locally try running: git clean -ffdx && ./mvnw -B clean package"
           exit 1
         fi
 
   code-style:
     runs-on: ubuntu-latest
+    if: ${{ github.event_name != 'pull_request' || !startsWith(github.head_ref, 'renovate/') }}
 
     strategy:
       matrix:
@@ -79,4 +82,4 @@ jobs:
         cache: 'maven'
 
     - name: Run Checkstyle
-      run: mvn -B checkstyle:check -P checkstyle -T2C
+      run: ./mvnw -B checkstyle:check -P checkstyle -T2C

.github/workflows/checkBuild.yml

@@ -25,7 +25,7 @@ jobs:
         cache: 'maven'
 
     - name: Build with Maven
-      run: mvn -B clean package
+      run: ./mvnw -B clean package
 
     - name: Check for uncommited changes
       run: |
@@ -41,7 +41,7 @@ jobs:
           echo ----------------------------------------
           echo Troubleshooting
           echo ----------------------------------------
-          echo "::error::Unstaged changes detected. Locally try running: git clean -ffdx && mvn -B clean package"
+          echo "::error::Unstaged changes detected. Locally try running: git clean -ffdx && ./mvnw -B clean package"
           exit 1
         fi
 
@@ -60,18 +60,19 @@ jobs:
   
     - name: Un-SNAP 
       run: |
+        mvnwPath=$(readlink -f ./mvnw)
         modules=("") # root
         modules+=($(grep -ozP '(?<=module>)[^<]+' 'pom.xml' | tr -d '\0'))
         for i in "${modules[@]}"
         do
             echo "Processing $i/pom.xml"
-            (cd "$i" && mvn -B versions:set -DremoveSnapshot -DgenerateBackupPoms=false)
+            (cd "$i" && $mvnwPath -B versions:set -DremoveSnapshot -DgenerateBackupPoms=false)
         done
   
     - name: Get version
       id: version
       run: |
-        version=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)
+        version=$(../mvnw help:evaluate -Dexpression=project.version -q -DforceStdout)
         echo "release=$version" >> $GITHUB_OUTPUT
         echo "releasenumber=${version//[!0-9]/}" >> $GITHUB_OUTPUT
       working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
@@ -127,15 +128,14 @@ jobs:
         gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }}
 
     - name: Publish to Apache Maven Central
-      run: mvn -B deploy -Possrh
+      run: ../mvnw -B deploy -Possrh
       env:
         MAVEN_CENTRAL_USERNAME: ${{ secrets.S01_OSS_SONATYPE_MAVEN_USERNAME }}
         MAVEN_CENTRAL_TOKEN: ${{ secrets.S01_OSS_SONATYPE_MAVEN_TOKEN }}
         MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
       working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
 
   publish-pages:
-    name: Publish dependencies and licenses to github pages
     runs-on: ubuntu-latest
     needs: [prepare_release]
     steps:
@@ -154,40 +154,15 @@ jobs:
         distribution: 'temurin'
         cache: 'maven'
 
-    - name: Build dependencies/licenses files
-      run: mvn -B project-info-reports:dependencies
+    - name: Build site
+      run: ../mvnw -B site
       working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
 
-    - name: Upload licenses - Upload Artifact
-      uses: actions/upload-artifact@v4
-      with:
-        name: dependencies-licenses
-        path: ${{ env.PRIMARY_MAVEN_MODULE }}/target/site
-
-    - name: Generate docs/dependencies dir
-      run: mkdir -p docs/dependencies
-
-    - name: Move built files into docs/dependencies
-      run: mv ${{ env.PRIMARY_MAVEN_MODULE }}/target/site/* docs/dependencies
-
-    - name: Rename dependencies.html to index.html
-      working-directory: docs/dependencies
-      run: mv dependencies.html index.html
-
-    - name: Copy Readme into docs (as index.md)
-      run: cp README.md docs/index.md
-
-    - name: Configure Pages
-      working-directory: docs
-      run: |-
-        echo "theme: jekyll-theme-tactile" > _config.yml
-
     - name: Deploy to Github pages
-      uses: peaceiris/actions-gh-pages@v3
+      uses: peaceiris/actions-gh-pages@v4
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ./docs
-        enable_jekyll: true
+        publish_dir: ./${{ env.PRIMARY_MAVEN_MODULE }}/target/site
 
   after_release:
     runs-on: ubuntu-latest
@@ -203,12 +178,13 @@ jobs:
 
     - name: Inc Version and SNAP 
       run: |
+        mvnwPath=$(readlink -f ./mvnw)
         modules=("") # root
         modules+=($(grep -ozP '(?<=module>)[^<]+' 'pom.xml' | tr -d '\0'))
         for i in "${modules[@]}"
         do
             echo "Processing $i/pom.xml"
-            (cd "$i" && mvn -B build-helper:parse-version versions:set -DnewVersion=\${parsedVersion.majorVersion}.\${parsedVersion.minorVersion}.\${parsedVersion.nextIncrementalVersion} -DgenerateBackupPoms=false -DnextSnapshot=true)
+            (cd "$i" && $mvnwPath -B build-helper:parse-version versions:set -DnewVersion=\${parsedVersion.majorVersion}.\${parsedVersion.minorVersion}.\${parsedVersion.nextIncrementalVersion} -DgenerateBackupPoms=false -DnextSnapshot=true)
         done
 
     - name: Git Commit and Push

.github/workflows/release.yml

@@ -7,13 +7,15 @@ on:
     paths-ignore: 
       - '**.md'
       - '.config/**'
+      - '.github/**'
       - '.idea/**'
       - 'assets/**'
   pull_request:
     types: [opened, synchronize, reopened]
     paths-ignore: 
       - '**.md'
       - '.config/**'
+      - '.github/**'
       - '.idea/**'
       - 'assets/**'
 
@@ -25,8 +27,7 @@ jobs:
   sonar:
     name: SonarCloud Scan
     runs-on: ubuntu-latest
-    # Dependabot PRs have no access to secrets (SONAR_TOKEN) -> Ignore them
-    if: ${{ github.event_name != 'pull_request' || !startsWith(github.head_ref, 'dependabot/') }}
+    if: ${{ github.event_name != 'pull_request' || !startsWith(github.head_ref, 'renovate/') }}
     steps:
       - uses: actions/checkout@v4
         with:
@@ -54,7 +55,7 @@ jobs:
 
       - name: Build with Maven
         run: |
-          mvn -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar \
+          ./mvnw -B verify org.sonarsource.scanner.maven:sonar-maven-plugin:sonar \
             -DskipTests \
             -Dsonar.projectKey=${{ env.SONARCLOUD_ORG }}_${{ github.event.repository.name }} \
             -Dsonar.organization=${{ env.SONARCLOUD_ORG }} \

.github/workflows/sonar.yml

@@ -24,7 +24,7 @@ jobs:
         gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }}
 
     - name: Publish to OSSRH
-      run: mvn -B deploy -Possrh
+      run: ../mvnw -B deploy -Possrh
       working-directory: ${{ env.PRIMARY_MAVEN_MODULE }}
       env:
         MAVEN_CENTRAL_USERNAME: ${{ secrets.S01_OSS_SONATYPE_MAVEN_USERNAME }}

.github/workflows/test-deploy.yml

@@ -0,0 +1,18 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.6/apache-maven-3.9.6-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar

.idea/checkstyle-idea.xml

@@ -20,7 +20,7 @@ We also encourage you to read the [contribution instructions by GitHub](https://
 You should have the following things installed:
 * Git
 * Java 21 - should be as unmodified as possible (Recommended: [Eclipse Adoptium](https://adoptium.net/temurin/releases/))
-* Maven
+* Maven (Note that the [Maven Wrapper](https://maven.apache.org/wrapper/) is shipped with the repo)
 
 ### Recommended setup
 * Install ``IntelliJ`` (Community Edition is sufficient)

.mvn/wrapper/maven-wrapper.properties

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2023 XDEV Software 
+   Copyright 2024 XDEV Software 
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.