Integrate zmscitizenview build workflow into combined workflows

[coderabbitai]

Description

Currently, the frontend build for zmscitizenview is handled in a separate workflow (maven-node-build.yaml) that runs independently of the combined workflows.

Requirements

• Integrate the frontend build steps from maven-node-build.yaml into:
  • combined-workflow.yaml
  • combined-workflow-with-docs.yaml
    • Generate test coverage report using ... and upload to Github pages.
• Add a new job in both workflows that calls the frontend build workflow
• Ensure proper dependency chain between jobs
• Remove standalone execution of the frontend build workflow

Acceptance Criteria

• Frontend build process runs as part of the combined workflows
• Build artifacts are correctly generated and available to downstream jobs
• No duplicate builds occur
• CI passes successfully with integrated workflows

[ThomasAFink]

@coderabbitai how can we add .github/workflows/maven-node-build.yaml to .github/workflows/combined-workflow-with-docs.yaml and .github/workflows/combined-workflow.yaml ?

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Get the content of the three workflow files we need to examine
echo "===== maven-node-build.yaml ====="
cat .github/workflows/maven-node-build.yaml || curl -s https://raw.githubusercontent.com/it-at-m/eappointment/main/.github/workflows/maven-node-build.yaml

echo -e "\n\n===== combined-workflow.yaml ====="
cat .github/workflows/combined-workflow.yaml || curl -s https://raw.githubusercontent.com/it-at-m/eappointment/main/.github/workflows/combined-workflow.yaml

echo -e "\n\n===== combined-workflow-with-docs.yaml ====="
cat .github/workflows/combined-workflow-with-docs.yaml || curl -s https://raw.githubusercontent.com/it-at-m/eappointment/main/.github/workflows/combined-workflow-with-docs.yaml

Length of output: 6051

---

@ThomasAFink Based on my analysis of all three workflow files, here's how you can integrate the maven-node-build.yaml into both combined workflows:

1. Modifications to combined-workflow.yaml

name: Combined Workflow

on:
  push:
    branches-ignore: [next]
    tags: ['*']
  workflow_call:

permissions:
  contents: read
  packages: write

jobs:
  call-php-code-quality:
    uses: ./.github/workflows/php-code-quality.yaml

  call-php-unit-tests:
    uses: ./.github/workflows/php-unit-tests.yaml

  call-owasp-security-checks:
    uses: ./.github/workflows/owasp-security-checks.yaml
    
  # Add new job for frontend build
  call-frontend-build:
    runs-on: ubuntu-latest
    env:
      TZ: Europe/Berlin
    strategy:
      fail-fast: false
      matrix:
        include:
          - app-path: zmscitizenview
    steps:
      - uses: it-at-m/lhm_actions/action-templates/actions/action-checkout@6b19f8dd2bee160bee82bde4fa04ac9f6c1d5e1e # v1.0.5
      - if: ${{hashFiles(format('./{0}/package.json', matrix.app-path))!=null}}
        id: node
        uses: it-at-m/lhm_actions/action-templates/actions/action-npm-build@6b19f8dd2bee160bee82bde4fa04ac9f6c1d5e1e # v1.0.5
        with:
          app-path: "${{ matrix.app-path }}"
      - if: ${{hashFiles(format('./{0}/pom.xml', matrix.app-path))!=null}}
        id: maven
        uses: it-at-m/lhm_actions/action-templates/actions/action-maven-build@6b19f8dd2bee160bee82bde4fa04ac9f6c1d5e1e # v1.0.5
        with:
          app-path: "${{ matrix.app-path }}"
      - if: github.ref == 'refs/heads/main'
        uses: it-at-m/lhm_actions/action-templates/actions/action-build-image@6b19f8dd2bee160bee82bde4fa04ac9f6c1d5e1e # v1.0.5
        with:
          path: "${{  matrix.app-path }}"
          image-name: "${{  matrix.app-path }}"
          artifact-name: ${{join(steps.*.outputs.artifact-name)}}
          registry-password: ${{ secrets.GITHUB_TOKEN }}
          registry-username: ${{ github.actor }}

  call-php-build-images:
    needs: [call-php-code-quality, call-php-unit-tests, call-frontend-build]
    if: |
      always() &&
      needs.call-php-code-quality.result == 'success' &&
      needs.call-php-unit-tests.result == 'success' &&
      needs.call-frontend-build.result == 'success'
    uses: ./.github/workflows/php-build-images.yaml

2. Modifications to combined-workflow-with-docs.yaml

name: Combined Workflow with Documentation

on:
  push:
    branches: [next]

permissions:
  contents: read
  packages: write
  pages: write
  id-token: write

jobs:
  call-php-code-quality:
    uses: ./.github/workflows/php-code-quality.yaml

  call-php-unit-tests:
    uses: ./.github/workflows/php-unit-tests.yaml

  call-owasp-security-checks:
    uses: ./.github/workflows/owasp-security-checks.yaml

  # Add new job for frontend build
  call-frontend-build:
    runs-on: ubuntu-latest
    env:
      TZ: Europe/Berlin
    strategy:
      fail-fast: false
      matrix:
        include:
          - app-path: zmscitizenview
    steps:
      - uses: it-at-m/lhm_actions/action-templates/actions/action-checkout@6b19f8dd2bee160bee82bde4fa04ac9f6c1d5e1e # v1.0.5
      - if: ${{hashFiles(format('./{0}/package.json', matrix.app-path))!=null}}
        id: node
        uses: it-at-m/lhm_actions/action-templates/actions/action-npm-build@6b19f8dd2bee160bee82bde4fa04ac9f6c1d5e1e # v1.0.5
        with:
          app-path: "${{ matrix.app-path }}"
          generate-coverage: true
      - name: Upload coverage report
        if: ${{hashFiles(format('./{0}/package.json', matrix.app-path))!=null}}
        uses: actions/upload-artifact@v4
        with:
          name: coverage-${{ matrix.app-path }}
          path: ${{ matrix.app-path }}/coverage
          retention-days: 7
      - if: ${{hashFiles(format('./{0}/pom.xml', matrix.app-path))!=null}}
        id: maven
        uses: it-at-m/lhm_actions/action-templates/actions/action-maven-build@6b19f8dd2bee160bee82bde4fa04ac9f6c1d5e1e # v1.0.5
        with:
          app-path: "${{ matrix.app-path }}"
      - if: github.ref == 'refs/heads/main'
        uses: it-at-m/lhm_actions/action-templates/actions/action-build-image@6b19f8dd2bee160bee82bde4fa04ac9f6c1d5e1e # v1.0.5
        with:
          path: "${{  matrix.app-path }}"
          image-name: "${{  matrix.app-path }}"
          artifact-name: ${{join(steps.*.outputs.artifact-name)}}
          registry-password: ${{ secrets.GITHUB_TOKEN }}
          registry-username: ${{ github.actor }}

  aggregate-reports:
    needs: [call-php-unit-tests, call-owasp-security-checks, call-frontend-build]
    runs-on: ubuntu-latest
    steps:
      - name: Create directories
        run: |
          mkdir -p public/coverage
          mkdir -p public/security

      - name: Download coverage reports
        uses: actions/download-artifact@v4
        with:
          pattern: 'coverage-*'
          path: public/coverage-temp
          merge-multiple: false

      - name: Download security reports
        uses: actions/download-artifact@v4
        with:
          pattern: 'security-report-*'
          path: public/security-temp
          merge-multiple: false

      - name: Fix directory structure
        run: |
          # Fix coverage reports
          for module in zmsadmin zmscalldisplay zmscitizenapi zmsdldb zmsentities zmsmessaging zmsslim zmsstatistic zmsticketprinter zmsapi zmsdb zmsclient zmscitizenview; do
            if [ -d "public/coverage-temp/coverage-$module" ]; then
              mkdir -p "public/coverage/coverage-$module"
              mv "public/coverage-temp/coverage-$module"/* "public/coverage/coverage-$module/"
            fi
          done
          rm -rf public/coverage-temp

          # Fix security reports
          for module in zmsadmin zmscalldisplay zmscitizenapi zmsdldb zmsentities zmsmessaging zmsslim zmsstatistic zmsticketprinter zmsapi zmsdb zmsclient zmscitizenview; do
            if [ -f "public/security-temp/security-report-$module/dependency-check-report.html" ]; then
              mkdir -p "public/security/security-report-$module"
              mv "public/security-temp/security-report-$module/dependency-check-report.html" "public/security/security-report-$module/"
            fi
          done
          rm -rf public/security-temp

      - name: Debug - List final structure
        run: |
          echo "=== Final Coverage Structure ==="
          ls -R public/coverage/
          echo "=== Final Security Structure ==="
          ls -R public/security/

      - name: Upload aggregated reports
        uses: actions/upload-artifact@v4
        with:
          name: aggregated-reports
          path: public/
          retention-days: 7

  call-build-api-docs:
    uses: ./.github/workflows/build-api-docs.yaml

  generate-schema-diagrams:
    uses: ./.github/workflows/generate-schema-diagrams.yaml

  deploy-to-pages:
    needs: [aggregate-reports, call-build-api-docs, generate-schema-diagrams]
    if: |
      needs.call-build-api-docs.result == 'success' &&
      needs.aggregate-reports.result == 'success' &&
      needs.generate-schema-diagrams.result == 'success'
    uses: ./.github/workflows/deploy-pages.yaml
    with:
      coverage_artifact: aggregated-reports
      api_docs_artifact: api-docs
      security_artifact: aggregated-reports
      git_commit: ${{ github.sha }}
      git_branch: ${{ github.ref_name }}

  call-php-build-images:
    needs: [call-php-code-quality, call-php-unit-tests, call-frontend-build]
    if: |
      always() &&
      needs.call-php-code-quality.result == 'success' &&
      needs.call-php-unit-tests.result == 'success' &&
      needs.call-frontend-build.result == 'success'
    uses: ./.github/workflows/php-build-images.yaml

Key changes:

1. Added call-frontend-build job to both workflows
2. In the docs workflow, added coverage report generation and upload
3. Updated job dependencies to include the new frontend build job
4. Added zmscitizenview to the list of modules in the report aggregation process
5. Included coverage report generation for frontend builds specifically in the docs workflow

After these changes, you can remove the standalone execution of the maven-node-build.yaml workflow or update its trigger to avoid duplicate builds.

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Examine all three workflow files to understand their structure
echo "Content of maven-node-build.yaml:"
cat .github/workflows/maven-node-build.yaml
echo -e "\n\n--- End of maven-node-build.yaml ---\n\n"

echo "Content of combined-workflow.yaml:"
cat .github/workflows/combined-workflow.yaml
echo -e "\n\n--- End of combined-workflow.yaml ---\n\n"

echo "Content of combined-workflow-with-docs.yaml:"
cat .github/workflows/combined-workflow-with-docs.yaml

Length of output: 6231

---

@ThomasAFink Based on analyzing the workflow files, here's how to integrate the maven-node-build.yaml into both combined workflows:

Step 1: Make the maven-node-build.yaml reusable

First, modify .github/workflows/maven-node-build.yaml to be callable:

name: Frontend Build

on:
  push:
  workflow_call:
    outputs:
      artifact-name:
        description: "Name of the generated artifact"
        value: ${{ jobs.build.outputs.artifact-name }}

jobs:
  build:
    runs-on: ubuntu-latest
    outputs:
      artifact-name: ${{ steps.node.outputs.artifact-name || steps.maven.outputs.artifact-name }}
    env:
      TZ: Europe/Berlin # timezone
    strategy:
      fail-fast: false
      matrix:
        include: # hier müssen die Pfade angegeben werden
          - app-path: zmscitizenview
    steps:
      - uses: it-at-m/lhm_actions/action-templates/actions/action-checkout@6b19f8dd2bee160bee82bde4fa04ac9f6c1d5e1e # v1.0.5
      - if: ${{hashFiles(format('./{0}/package.json', matrix.app-path))!=null}}
        id: node
        uses: it-at-m/lhm_actions/action-templates/actions/action-npm-build@6b19f8dd2bee160bee82bde4fa04ac9f6c1d5e1e # v1.0.5
        with:
          app-path: "${{ matrix.app-path }}"
      - if: ${{hashFiles(format('./{0}/pom.xml', matrix.app-path))!=null}}
        id: maven
        uses: it-at-m/lhm_actions/action-templates/actions/action-maven-build@6b19f8dd2bee160bee82bde4fa04ac9f6c1d5e1e # v1.0.5
        with:
          app-path: "${{ matrix.app-path }}"
      - if: github.ref == 'refs/heads/main'
        uses: it-at-m/lhm_actions/action-templates/actions/action-build-image@6b19f8dd2bee160bee82bde4fa04ac9f6c1d5e1e # v1.0.5
        with:
          path: "${{  matrix.app-path }}"
          image-name: "${{  matrix.app-path }}"
          artifact-name: ${{join(steps.*.outputs.artifact-name)}}
          registry-password: ${{ secrets.GITHUB_TOKEN }}
          registry-username: ${{ github.actor }}

Step 2: Update combined-workflow.yaml

Add the frontend build job to .github/workflows/combined-workflow.yaml:

name: Combined Workflow

on:
  push:
    branches-ignore: [next]
    tags: ['*']
  workflow_call:

permissions:
  contents: read
  packages: write

jobs:
  call-php-code-quality:
    uses: ./.github/workflows/php-code-quality.yaml

  call-php-unit-tests:
    uses: ./.github/workflows/php-unit-tests.yaml

  call-owasp-security-checks:
    uses: ./.github/workflows/owasp-security-checks.yaml

  call-frontend-build:
    uses: ./.github/workflows/maven-node-build.yaml

  call-php-build-images:
    needs: [call-php-code-quality, call-php-unit-tests, call-frontend-build]
    if: |
      always() &&
      needs.call-php-code-quality.result == 'success' &&
      needs.call-php-unit-tests.result == 'success' &&
      needs.call-frontend-build.result == 'success'
    uses: ./.github/workflows/php-build-images.yaml

Step 3: Update combined-workflow-with-docs.yaml

Add the frontend build job to .github/workflows/combined-workflow-with-docs.yaml and include frontend code coverage in the reports:

name: Combined Workflow with Documentation

on:
  push:
    branches: [next]

permissions:
  contents: read
  packages: write
  pages: write
  id-token: write

jobs:
  call-php-code-quality:
    uses: ./.github/workflows/php-code-quality.yaml

  call-php-unit-tests:
    uses: ./.github/workflows/php-unit-tests.yaml

  call-owasp-security-checks:
    uses: ./.github/workflows/owasp-security-checks.yaml

  call-frontend-build:
    uses: ./.github/workflows/maven-node-build.yaml

  aggregate-reports:
    needs: [call-php-unit-tests, call-owasp-security-checks, call-frontend-build]
    runs-on: ubuntu-latest
    steps:
      - name: Create directories
        run: |
          mkdir -p public/coverage
          mkdir -p public/security
          mkdir -p public/frontend-coverage

      - name: Download coverage reports
        uses: actions/download-artifact@v4
        with:
          pattern: 'coverage-*'
          path: public/coverage-temp
          merge-multiple: false

      - name: Download security reports
        uses: actions/download-artifact@v4
        with:
          pattern: 'security-report-*'
          path: public/security-temp
          merge-multiple: false
          
      - name: Download frontend coverage reports
        uses: actions/download-artifact@v4
        with:
          pattern: 'frontend-coverage-*'
          path: public/frontend-coverage-temp
          merge-multiple: false

      - name: Fix directory structure
        run: |
          # Fix coverage reports
          for module in zmsadmin zmscalldisplay zmscitizenapi zmsdldb zmsentities zmsmessaging zmsslim zmsstatistic zmsticketprinter zmsapi zmsdb zmsclient; do
            if [ -d "public/coverage-temp/coverage-$module" ]; then
              mkdir -p "public/coverage/coverage-$module"
              mv "public/coverage-temp/coverage-$module"/* "public/coverage/coverage-$module/"
            fi
          done
          rm -rf public/coverage-temp

          # Fix security reports
          for module in zmsadmin zmscalldisplay zmscitizenapi zmsdldb zmsentities zmsmessaging zmsslim zmsstatistic zmsticketprinter zmsapi zmsdb zmsclient; do
            if [ -f "public/security-temp/security-report-$module/dependency-check-report.html" ]; then
              mkdir -p "public/security/security-report-$module"
              mv "public/security-temp/security-report-$module/dependency-check-report.html" "public/security/security-report-$module/"
            fi
          done
          rm -rf public/security-temp
          
          # Fix frontend coverage reports
          if [ -d "public/frontend-coverage-temp" ]; then
            mv public/frontend-coverage-temp/* public/frontend-coverage/
          fi
          rm -rf public/frontend-coverage-temp

      - name: Debug - List final structure
        run: |
          echo "=== Final Coverage Structure ==="
          ls -R public/coverage/
          echo "=== Final Security Structure ==="
          ls -R public/security/
          echo "=== Final Frontend Coverage Structure ==="
          ls -R public/frontend-coverage/

      - name: Upload aggregated reports
        uses: actions/upload-artifact@v4
        with:
          name: aggregated-reports
          path: public/
          retention-days: 7

  call-build-api-docs:
    uses: ./.github/workflows/build-api-docs.yaml

  generate-schema-diagrams:
    uses: ./.github/workflows/generate-schema-diagrams.yaml

  deploy-to-pages:
    needs: [aggregate-reports, call-build-api-docs, generate-schema-diagrams]
    if: |
      needs.call-build-api-docs.result == 'success' &&
      needs.aggregate-reports.result == 'success' &&
      needs.generate-schema-diagrams.result == 'success'
    uses: ./.github/workflows/deploy-pages.yaml
    with:
      coverage_artifact: aggregated-reports
      api_docs_artifact: api-docs
      security_artifact: aggregated-reports
      git_commit: ${{ github.sha }}
      git_branch: ${{ github.ref_name }}

  call-php-build-images:
    needs: [call-php-code-quality, call-php-unit-tests, call-frontend-build]
    if: |
      always() &&
      needs.call-php-code-quality.result == 'success' &&
      needs.call-php-unit-tests.result == 'success' &&
      needs.call-frontend-build.result == 'success'
    uses: ./.github/workflows/php-build-images.yaml

Step 4: Update maven-node-build.yaml to generate test coverage reports

To generate test coverage for the frontend, modify the npm build step in maven-node-build.yaml:

- if: ${{hashFiles(format('./{0}/package.json', matrix.app-path))!=null}}
  id: node
  uses: it-at-m/lhm_actions/action-templates/actions/action-npm-build@6b19f8dd2bee160bee82bde4fa04ac9f6c1d5e1e # v1.0.5
  with:
    app-path: "${{ matrix.app-path }}"
    
- name: Generate and upload frontend coverage
  if: ${{hashFiles(format('./{0}/package.json', matrix.app-path))!=null}}
  run: |
    cd ${{ matrix.app-path }}
    npm run test:coverage
    
- name: Upload frontend coverage
  if: ${{hashFiles(format('./{0}/package.json', matrix.app-path))!=null}}
  uses: actions/upload-artifact@v4
  with:
    name: frontend-coverage-${{ matrix.app-path }}
    path: ${{ matrix.app-path }}/coverage
    retention-days: 7

These changes will integrate the zmscitizenview frontend build into both combined workflows, ensuring proper dependency chains and generating test coverage reports for GitHub Pages deployment.