chore: Implement setup-build-environment action and streamline workflows

MichaelsJP · MichaelsJP · commit 8548e06c4d90 · 2025-12-02T23:15:27.000+01:00
diff --git a/.github/actions/setup-build-environment/action.yml b/.github/actions/setup-build-environment/action.yml
@@ -0,0 +1,56 @@
+name: Setup Build Environment
+description: Set up Java/Maven and optionally Docker (QEMU + Buildx) with Maven cache injection
+inputs:
+  java_version:
+    description: Java version to install
+    required: false
+    default: '21'
+  with_docker:
+    description: Set up Docker (Buildx) for image builds
+    required: false
+    default: 'true'
+  dockerfile:
+    description: Path to the primary Dockerfile to use for buildkit injection (only used if with_docker is true)
+    required: false
+    default: 'Dockerfile'
+outputs:
+  buildx_builder:
+    description: Name of the buildx builder (only available if with_docker is true)
+    value: ${{ steps.buildx.outputs.name }}
+  cache-hit:
+    description: Whether the Maven cache was hit
+    value: ${{ steps.setup-java.outputs.cache-hit }}
+runs:
+  using: composite
+  steps:
+    - name: Setup Java and Maven
+      id: setup-java
+      uses: ./.github/actions/setup-java-maven
+      with:
+        java_version: ${{ inputs.java_version }}
+
+    - name: Set up Docker Buildx
+      if: inputs.with_docker == 'true'
+      id: buildx
+      uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 #v3.11.1
+
+    - name: Prepare all Dockerfiles for Maven cache mount
+      if: inputs.with_docker == 'true'
+      shell: bash
+      run: |
+        # Find and prepare all Dockerfiles in the repository
+        find . -name "Dockerfile" -o -name "*.Dockerfile" | while read dockerfile; do
+          sed -i "s|RUN \./mvnw |RUN --mount=type=cache,target=/root/.m2/repository ./mvnw |g" "$dockerfile"
+        done
+
+    - name: Inject Maven cache into Docker build
+      if: inputs.with_docker == 'true'
+      uses: 'reproducible-containers/buildkit-cache-dance@5b81f4d29dc8397a7d341dba3aeecc7ec54d6361' # v3.3.0
+      with:
+        builder: ${{ steps.buildx.outputs.name }}
+        dockerfile: ${{ inputs.dockerfile }}
+        skip-extraction: ${{ steps.setup-java.outputs.cache-hit }}
+        cache-map: |
+          {
+            "/home/runner/.m2/repository": "/root/.m2/repository"
+          }
diff --git a/.github/workflows/_build-docker-images.yml b/.github/workflows/_build-docker-images.yml
@@ -75,10 +75,6 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Setup Java and Maven
-        uses: ./.github/actions/setup-java-maven
-        with:
-          java_version: ${{ inputs.java_version }}
 
   build_docker_images:
     name: Build ${{ matrix.image_stage }} for ${{ matrix.name }}
@@ -134,25 +130,12 @@ jobs:
         run: |
           echo "UID=$(id -u)" >> $GITHUB_ENV
 
-      - name: Set up Docker Buildx
-        if: steps.should_skip.outputs.skip != 'true'
-        uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 #v3.11.1
-        id: buildx
-
-      - name: Setup Java and Maven
-        id: setup-java
+      - name: Set up build environment
         if: steps.should_skip.outputs.skip != 'true'
-        uses: ./.github/actions/setup-java-maven
+        uses: ./.github/actions/setup-build-environment
         with:
           java_version: ${{ inputs.java_version }}
-
-      - name: Maven cache dance
-        if: steps.should_skip.outputs.skip != 'true'
-        uses: ./.github/actions/maven-cache-dance
-        with:
-          builder: ${{ steps.buildx.outputs.name }}
           dockerfile: 'Dockerfile'
-          cache-hit: ${{ steps.setup-java.outputs.cache-hit }}
 
       - name: Resolve Docker tag
         if: steps.should_skip.outputs.skip != 'true'
diff --git a/.github/workflows/docker-nightly-image.yml b/.github/workflows/docker-nightly-image.yml
@@ -29,59 +29,77 @@ on:
         default: 'schedule'
 
 jobs:
-  check-commits:
+  prepare_environment:
+    name: Prepare the environment variables
     runs-on: ubuntu-latest
     outputs:
-      new_commits: ${{ steps.check.outputs.NEW_COMMITS }}
+      docker_tag: ${{ steps.resolve-tag.outputs.tag }}
+    steps:
+      - name: Resolve Docker tag
+        id: resolve-tag
+        env:
+          TAG_INPUT: ${{ inputs.tag || 'nightly' }}
+          DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+        run: |
+          echo "tag=${DOCKER_USERNAME}/openrouteservice:${TAG_INPUT}" >> $GITHUB_OUTPUT
+
+  check_commits:
+    name: Check for new commits
+    runs-on: ubuntu-latest
+    outputs:
+      new_commits: ${{ steps.check.outputs.new_commits }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
         with:
           repository: ${{ inputs.repository || 'GIScience/openrouteservice' }}
           ref: ${{ inputs.branch || 'main' }}
 
-      - name: Check for new commits since 24 h ago
+      - name: Check for new commits since 24 hours ago
         id: check
         run: |
-          export LOG_LINES=$(git log --oneline --since '24 hours ago')
-          export NUM_LINES=$(echo "$LOG_LINES" | grep -c .)
+          LOG_LINES=$(git log --oneline --since '24 hours ago')
+          NUM_LINES=$(echo "$LOG_LINES" | grep -c .)
           if [ "$NUM_LINES" -eq "0" ]; then
-            export NEW_COMMITS="false"
+            NEW_COMMITS="false"
           else
-            export NEW_COMMITS="true"
+            NEW_COMMITS="true"
           fi
-          echo "NEW_COMMITS=$NEW_COMMITS" >> "$GITHUB_OUTPUT"
+          echo "new_commits=$NEW_COMMITS" >> "$GITHUB_OUTPUT"
 
-  build:
-    needs: check-commits
+  build_and_push:
+    name: Build and push nightly image
+    needs:
+      - prepare_environment
+      - check_commits
     runs-on: ubuntu-latest
-    if: inputs.ignore-24h-commit-check || needs.check-commits.outputs.new_commits == 'true'
+    if: inputs.ignore-24h-commit-check || needs.check_commits.outputs.new_commits == 'true'
     steps:
       - name: Checkout
         uses: actions/checkout@v4
         with:
           repository: ${{ inputs.repository || 'GIScience/openrouteservice' }}
           ref: ${{ inputs.branch || 'main' }}
 
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3.0.0
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3.0.0
+      - name: Set up build environment
+        uses: ./.github/actions/setup-build-environment
+        with:
+          dockerfile: 'Dockerfile'
 
       - name: Login to DockerHub
-        uses: docker/login-action@v3.0.0
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
-      - name: Build and push
-        uses: docker/build-push-action@v5.1.0
+      - name: Build and push image
+        uses: docker/build-push-action@v6
         with:
           context: .
+          build-args: MAVEN_OPTS=-Dmaven.repo.local=/root/.m2/repository
           platforms: linux/amd64,linux/arm64/v8
           provenance: false
           push: true
           cache-from: type=gha
           cache-to: type=gha,mode=max
-          tags: ${{ secrets.DOCKER_USERNAME }}/openrouteservice:${{ inputs.tag || 'nightly' }}
+          tags: ${{ needs.prepare_environment.outputs.docker_tag }}
diff --git a/.github/workflows/run_maven_tests.yml b/.github/workflows/run_maven_tests.yml
@@ -17,8 +17,10 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Setup Java and Maven
-        uses: ./.github/actions/setup-java-maven
+      - name: Setup build environment
+        uses: ./.github/actions/setup-build-environment
+        with:
+          with_docker: 'false'
       - name: Cache SonarCloud packages
         uses: actions/cache@v4
         with:
diff --git a/.github/workflows/vulnerability-scanning.yml b/.github/workflows/vulnerability-scanning.yml
@@ -86,18 +86,10 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-        id: buildx
-      - name: Setup Java and Maven
-        id: setup-java
-        uses: ./.github/actions/setup-java-maven
-      - name: inject maven-build-cache into docker
-        uses: ./.github/actions/maven-cache-dance
+      - name: Set up build environment
+        uses: ./.github/actions/setup-build-environment
         with:
-          builder: ${{ steps.buildx.outputs.name }}
           dockerfile: 'Dockerfile'
-          cache-hit: ${{ steps.setup-java.outputs.cache-hit }}
       - name: Build image for ${{ matrix.platform }}
         uses: docker/build-push-action@v6
         with:
