Merge pull request #192 from mfd2007/chore_change_to_maven

Chore: Migrate build process from gradle to maven

Author: tschmidtb51

.github/workflows/github-actions.yml

@@ -1,47 +1,62 @@
-name: Validate and Test
+name: Build and Test
 on:
-  push:
-    branches-ignore:
-      - gh-pages
+  pull_request:
+    branches:    
+      - main
 jobs:
-  gradle:
+  build: 
     runs-on: ubuntu-latest
     permissions:
       checks: write
+      contents: write
       pull-requests: write
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-java@v3
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up JDK
+        uses: actions/setup-java@v3
         with:
-          java-version: '17'
+          java-version: '21'
           distribution: 'adopt'
-      - name: Setup Gradle
-        uses: gradle/gradle-build-action@v2.4.2
-        with:
-          gradle-version: 8.2.1
-      - name: Change wrapper permissions
-        run: chmod +x ./gradlew
-      - name: Execute Gradle build
-        run: ./gradlew clean build jacocoTestReport
+          cache: maven
+      - name: Build with maven
+        run: mvn -Pgithub-action clean verify
+        
       - name: Publish Unit Test Results
         uses: EnricoMi/publish-unit-test-result-action@v2
-        if: always() # clause guarantees that this action always runs, even if earlier steps (e.g., the unit test step) in your workflow fail.
+        #if: always() # clause guarantees that this action always runs, even if earlier steps (e.g., the unit test step) in your workflow fail.
         with:
-          files: "build/test-results/**/*.xml"
+          files: ${{ github.workspace }}/target/surefire-reports/**/*.xml
       - name: Add coverage to PR
         id: jacoco
         uses: madrapps/jacoco-report@v1.6.1  # requires at least two pushes to a PR, see https://github.com/Madrapps/jacoco-report/issues/13
         with:
-          paths: ${{ github.workspace }}/build/reports/jacoco/test/jacocoTestReport.xml
+          paths: ${{ github.workspace }}/target/jacoco-report/jacoco.xml
           token: ${{ secrets.GITHUB_TOKEN }}
           min-coverage-overall: 40
           min-coverage-changed-files: 60
       - name: Archive code coverage results
         uses: actions/upload-artifact@v3
         with:
           name: code-coverage-report
-          path: build/reports/jacoco/**
-          
+          path: target/jacoco-report/**
+      - name: ls
+        run: ls -al target/jacoco-report/
+      - name: Generate JaCoCo Badge
+        uses: cicirello/jacoco-badge-generator@v2
+        with:
+          jacoco-csv-file: target/jacoco-report/jacoco.csv
+          generate-coverage-badge: true
+          badges-directory: .github/badges
+      - name: Commit the badge (if it changed)
+        run: |
+          git config user.name 'github-actions[bot]'
+          git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
+          if [[ `git diff --exit-code .github/badges/jacoco.svg` ]]; then
+            git add .github/badges/jacoco.svg
+            git commit -m "Autogenerated JaCoCo coverage badge"
+            git push
+          fi
   lint-markdown:
     name: Lint all markdown files in project
     runs-on: ubuntu-latest
@@ -52,18 +67,5 @@ jobs:
         uses: nosborn/github-action-markdown-cli@v3.0.1
         with:
           files: '**/*.md'
-  checkstyle:
-    runs-on: ubuntu-latest
-    name: Run CheckStyle
-    steps:
-      - name: Check out code
-        uses: actions/checkout@v3
-      - name: Run CheckStyle
-        uses: nikitasavinov/checkstyle-action@master
-        with:
-          checkstyle_config: checkstyle.xml
-          level: error
-          fail_on_error: true
-          reporter: 'github-check'
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+
 

.github/workflows/github-pages.yml

@@ -15,3 +15,5 @@ out/
 
 ### local configuration ###
 .env
+/bin/
+/target/

.gitignore

@@ -42,10 +42,10 @@ only required to manage documents on the server or validate against the
 To build the application run:
 
 ```shell
-./gradlew clean build
+./mvn package
 ```
 
-The resulting jar file in the `build/libs` folder can then be run with
+The resulting jar file in the `target` folder can then be run with
 `java -jar filename.jar`. To manage the process you can use Docker or an init
 system of your choice.
 
@@ -115,15 +115,12 @@ The port is defined in .env - CSAF_APP_EXTERNAL_PORT, default 4180
 
 ### build and execute tests
 
-./gradlew clean build
+./mvnw clean verify
 
-### build and run SpotBugs
-
-./gradlew clean assemble spotbugsMain
 
 ### start application
 
-./gradlew bootRun
+./mvnw spring-boot:run
 
 with main class: de.bsi.secvisogram.csaf_cms_backend.SecvisogramApplication
 
@@ -139,7 +136,7 @@ http://localhost:8081/swagger-ui/index.html
 
 OpenAPI specification
 
-http://localhost:8081/v3/api-docs/
+http://localhost:8081/api-docs/
 
 ### access couchDB
 
@@ -159,6 +156,13 @@ You can find our guidelines here [CONTRIBUTING.md](https://github.com/secvisogra
 
 ## Dependencies
 
+### Check for Maven Plugin update
+
+`` mvn versions:display-plugin-updates `` 
+
+## Check for dependency update
+`` mvn versions:display-dependency-updates `
+
 ### Spring Boot
 
 #### Reference Documentation