sub_buildWindows.yml

# ***************************************************************************
# *   Copyright (c) 2023 0penBrain                               *
# *                                                                         *
# *   This program is free software; you can redistribute it and/or modify  *
# *   it under the terms of the GNU Lesser General Public License (LGPL)    *
# *   as published by the Free Software Foundation; either version 2 of     *
# *   the License, or (at your option) any later version.                   *
# *   for detail see the LICENCE text file.                                 *
# *                                                                         *
# *   This program is distributed in the hope that it will be useful,       *
# *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
# *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
# *   GNU Library General Public License for more details.                  *
# *                                                                         *
# *   You should have received a copy of the GNU Library General Public     *
# *   License along with this program; if not, write to the Free Software   *
# *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
# *   USA                                                                   *
# *                                                                         *
# ***************************************************************************

# This is a build and test workflow for CI of FreeCAD.
# This workflow aims at building and testing FreeCAD on Windows using MSVC.

name: Build Windows
on:
  workflow_dispatch:
    inputs:
      artifactBasename:
        description: "Base name for artifact"
        required: false
        type: string
        default: "FreeCAD"
      allowedToFail:
        description: "whether a failed build is allowed"
        required: false
        type: boolean
        default: false
  workflow_call:
    inputs:
      artifactBasename:
        required: true
        type: string
      allowedToFail:
        required: false
        default: false
        type: boolean
    outputs:
      reportFile:
        value: ${{ jobs.Build.outputs.reportFile }}

jobs:
  Build:
    runs-on: windows-latest
    continue-on-error: ${{ inputs.allowedToFail }}
    env:
      CCACHE_COMPILERCHECK: "%compiler%" # default:mtime
      CCACHE_COMPRESS: true
      CCACHE_COMPRESSLEVEL: 5
      CCACHE_DIR: C:/FC/cache/
      CCACHE_LOGFILE: C:/logs/ccache.log
      CCACHE_MAXSIZE: 1G
      CCACHE_NODIRECT: true
      CCACHE_NOHASHDIR: true
      CCACHE_NOINODECACHE: true
      CCACHE_SLOPPINESS: "include_file_ctime,include_file_mtime,pch_defines,time_macros" # Can't get PCH to work on Windows
      ## Have to use C:\ because not enough space on workspace drive
      builddir: C:/FC/build/release/
      cacheKey: Windows
      ccachebindir: C:/FC/ccache/
      config: release
      libpackdir: C:/FC/libpack/
      logdir: C:/logs/
      reportdir: C:/report/
      reportfilename: ${{ inputs.artifactBasename }}-report.md
    outputs:
      reportFile: ${{ steps.Init.outputs.reportFile }}

    steps:
      - name: Harden the runner (Audit all outbound calls)
        uses: step-security/harden-runner@fe104658747b27e96e4f7e80cd0a94068e53901d # v2.16.1
        with:
          egress-policy: audit

      - name: Checking out source code
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          submodules: true

      - name: Make needed directories, files and initializations
        id: Init
        run: |
          mkdir ${{ env.CCACHE_DIR }}
          mkdir ${{ env.ccachebindir }}
          mkdir ${{ env.libpackdir }}
          mkdir ${{ env.builddir }}
          mkdir ${{ env.logdir }}
          mkdir ${{ env.reportdir }}
          echo "reportFile=${{ env.reportfilename }}" >> $GITHUB_OUTPUT

      - name: Get Ccache
        uses: ./.github/workflows/actions/windows/getCcache
        with:
          ccachebindir: ${{ env.ccachebindir }}

      - name: Get Libpack
        uses: ./.github/workflows/actions/windows/getLibpack
        with:
          libpackdir: ${{ env.libpackdir }}

      - name: Restore compiler cache
        id: cache-restore
        if: always()
        uses: actions/cache/restore@668228422ae6a00e4ad889ee87cd7109ec5666a7 # v5.0.4
        with:
          path: ${{ env.CCACHE_DIR }}
          key: FC-${{ env.cacheKey }}-${{ github.ref }}-${{ github.run_id }}
          restore-keys: |
            FC-${{ env.cacheKey }}-${{ github.ref }}-
            FC-${{ env.cacheKey }}-

      - name: Print Ccache statistics before build, reset stats and print config
        run: |
          . $env:ccachebindir\ccache -s
          . $env:ccachebindir\ccache -z
          . $env:ccachebindir\ccache -p

      - name: Install cmake
        uses: jwlawson/actions-setup-cmake@0d6a7d60b009d01c9e7523be22153ff8f19460d3 # v2.2.0
        with:
          cmake-version: '3.31.6'

      - name: Configuring CMake
        run: >
          cmake -B"${{ env.builddir }}" .
          --preset ${{ env.config }}
          -DCMAKE_VS_NO_COMPILE_BATCHING=ON
          -DCMAKE_BUILD_TYPE=Release
          -DFREECAD_USE_PCH=OFF
          -DFREECAD_RELEASE_PDB=OFF
          -DFREECAD_LIBPACK_DIR="${{ env.libpackdir }}"
          -DFREECAD_COPY_DEPEND_DIRS_TO_BUILD=ON
          -DFREECAD_COPY_LIBPACK_BIN_TO_BUILD=ON
          -DFREECAD_COPY_PLUGINS_BIN_TO_BUILD=ON

      - name: Add msbuild to PATH
        uses: microsoft/setup-msbuild@30375c66a4eea26614e0d39710365f22f8b0af57 # v3.0.0

      - name: Compiling sources
        run: |
          cd $env:builddir
          msbuild ALL_BUILD.vcxproj /m /p:Configuration=Release /p:TrackFileAccess=false /p:CLToolPath=${{ env.ccachebindir }}

      - name: Print Ccache statistics after build
        if: always()
        run: |
          . $env:ccachebindir\ccache -s

      - name: C++ unit tests
        if: false # Disabled because seems to not function on Windows build
        timeout-minutes: 1
        run: |
          . ${{ env.builddir }}\tests\Release\Tests_run --gtest_output=json:${{ env.reportdir }}gtest_results.json # 2>&1 | tee -filepath ${{ env.logdir }}\unitTests.log

      - name: FreeCAD CLI tests
        run: |
          . ${{ env.builddir }}\bin\FreeCADCmd -t 0 # 2>&1 | tee -filepath ${{ env.logdir }}\integrationTests.log

      - name: Save Compiler Cache
        id: cache-save
        if: always()
        uses: actions/cache/save@668228422ae6a00e4ad889ee87cd7109ec5666a7 # v5.0.4
        with:
          path: ${{ env.CCACHE_DIR }}
          key: FC-${{ env.cacheKey }}-${{ github.ref }}-${{ github.run_id }}

      - name: Upload logs
        if: always()
        uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
        with:
          name: ${{ inputs.artifactBasename }}-Logs
          path: |
            ${{ env.logdir }}