build-test-package.yml

name: Build, test, package

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

env:
  # v6.0a02
  itk-git-tag: "v6.0a02"
  itk-wheel-tag: "v6.0a02"
  # v6.0a02 + fixes
  itk-python-package-tag: "v6.0a02"
  itk-python-package-org: "InsightSoftwareConsortium"

jobs:
  build-test-cxx:
    runs-on: ${{ matrix.os }}
    strategy:
      max-parallel: 3
      matrix:
        # runners macos-13 is x86_64, macos-15 is arm64 by default
        os: [ubuntu-24.04, windows-2022, macos-13, macos-15]
        include:
          - os: ubuntu-24.04
            c-compiler: "gcc"
            cxx-compiler: "g++"
            cmake-build-type: "MinSizeRel"
          - os: windows-2022
            c-compiler: "cl.exe"
            cxx-compiler: "cl.exe"
            cmake-build-type: "Release"
          - os: macos-13
            c-compiler: "clang"
            cxx-compiler: "clang++"
            cmake-build-type: "MinSizeRel"
            deployment_target: '10.9'
          - os: macos-15
            c-compiler: "clang"
            cxx-compiler: "clang++"
            cmake-build-type: "MinSizeRel"
            deployment_target: '13.0'

    steps:
    - uses: actions/checkout@v4.2.2

    - name: Free Disk Space (Ubuntu)
      if: matrix.os == 'ubuntu-24.04'
      uses: jlumbroso/free-disk-space@v1.3.1
      with:
        large-packages: false

    - name: Set up Python 3.11
      uses: actions/setup-python@v5.4.0
      with:
        python-version: "3.11"

    - name: Install build dependencies
      run: |
        python -m pip install --upgrade pip
        python -m pip install ninja
        python -m pip install cookiecutter

    - name: Get specific version of CMake, Ninja
      uses: lukka/get-cmake@v3.31.5

    - name: 'Specific XCode version 14.3.1'
      if: matrix.os == 'macos-13'
      run: |
        sudo xcode-select -s "/Applications/Xcode_14.3.1.app"

    - name: 'Specific XCode version 16.2'
      if: matrix.os == 'macos-15'
      run: |
        sudo xcode-select -s "/Applications/Xcode_16.2.app"

    - name: Download ITK
      run: |
        cd ..
        git clone https://github.com/InsightSoftwareConsortium/ITK.git
        cd ITK
        git checkout ${{ env.itk-git-tag }}

    - name: Build ITK
      if: matrix.os != 'windows-2022'
      shell: bash
      run: |
        cd ..
        mkdir ITK-build
        cd ITK-build
        cmake -DCMAKE_C_COMPILER:FILEPATH="${{ matrix.c-compiler }}" -DBUILD_SHARED_LIBS:BOOL=ON -DCMAKE_CXX_COMPILER="${{ matrix.cxx-compiler }}" -DCMAKE_BUILD_TYPE:STRING=${{ matrix.cmake-build-type }} -DBUILD_TESTING:BOOL=OFF -GNinja ../ITK
        ninja

    - name: Build ITK
      if: matrix.os == 'windows-2022'
      shell: pwsh
      run: |
        Set-PSDebug -Trace 1
        cd ..
        mkdir ITK-build
        cd ITK-build
        & "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\Common7\Tools\Launch-VsDevShell.ps1" -Arch amd64 -SkipAutomaticLocation
        cmake -DCMAKE_C_COMPILER:FILEPATH="${{ matrix.c-compiler }}" -DBUILD_SHARED_LIBS:BOOL=ON -DCMAKE_CXX_COMPILER="${{ matrix.cxx-compiler }}" -DCMAKE_BUILD_TYPE:STRING=${{ matrix.cmake-build-type }} -DBUILD_TESTING:BOOL=OFF -GNinja ../ITK
        ninja

    - name: Fetch CTest driver script
      run: |
        curl -L https://raw.githubusercontent.com/InsightSoftwareConsortium/ITK/dashboard/itk_common.cmake -O

    - name: Evaluate template
      shell: bash
      run: |
        python -m cookiecutter --no-input --output-dir "${GITHUB_WORKSPACE}/../Evaluated" "${GITHUB_WORKSPACE}"
        mkdir "${GITHUB_WORKSPACE}/../Evaluated/ITKModuleTemplate/.git"

    - name: Configure CTest script
      shell: bash
      run: |
        operating_system="${{ matrix.os }}"
        cat > dashboard.cmake << EOF
        set(CTEST_SITE "GitHubActions")
        file(TO_CMAKE_PATH "\$ENV{GITHUB_WORKSPACE}/.." CTEST_DASHBOARD_ROOT)
        file(TO_CMAKE_PATH "\$ENV{GITHUB_WORKSPACE}/../Evaluated/ITKModuleTemplate" CTEST_SOURCE_DIRECTORY)
        file(TO_CMAKE_PATH "\$ENV{GITHUB_WORKSPACE}/../build" CTEST_BINARY_DIRECTORY)
        set(dashboard_source_name "${GITHUB_REPOSITORY}")
        if(ENV{GITHUB_REF} MATCHES "main")
          set(branch "-main")
          set(dashboard_model "Continuous")
        else()
          set(branch "-${GITHUB_REF}")
          set(dashboard_model "Experimental")
        endif()
        set(CTEST_BUILD_NAME "${GITHUB_REPOSITORY}-${operating_system}-\${branch}")
        set(CTEST_UPDATE_VERSION_ONLY 1)
        set(CTEST_TEST_ARGS \${CTEST_TEST_ARGS} PARALLEL_LEVEL \${PARALLEL_LEVEL})
        set(CTEST_BUILD_CONFIGURATION "Release")
        set(CTEST_CMAKE_GENERATOR "Ninja")
        set(CTEST_CUSTOM_WARNING_EXCEPTION
          \${CTEST_CUSTOM_WARNING_EXCEPTION}
          # macOS Azure VM Warning
          "ld: warning: text-based stub file"
          )
        set(dashboard_no_clean 1)
        set(ENV{CC} ${{ matrix.c-compiler }})
        set(ENV{CXX} ${{ matrix.cxx-compiler }})
        if(WIN32)
          set(ENV{PATH} "\${CTEST_DASHBOARD_ROOT}/ITK-build/bin;\$ENV{PATH}")
        endif()
        set(dashboard_cache "
        ITK_DIR:PATH=\${CTEST_DASHBOARD_ROOT}/ITK-build
        BUILD_TESTING:BOOL=ON
        ")
        string(TIMESTAMP build_date "%Y-%m-%d")
        message("CDash Build Identifier: \${build_date} \${CTEST_BUILD_NAME}")
        message("CTEST_SITE = \${CTEST_SITE}")
        include(\${CTEST_SCRIPT_DIRECTORY}/itk_common.cmake)
        EOF
        cat dashboard.cmake

    - name: Build and test
      if: matrix.os != 'windows-2022'
      run: |
        ctest --output-on-failure -j 2 -V -S dashboard.cmake

    - name: Build and test
      if: matrix.os == 'windows-2022'
      shell: pwsh
      run: |
        & "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\Common7\Tools\Launch-VsDevShell.ps1" -Arch amd64 -SkipAutomaticLocation
        ctest --output-on-failure -j 2 -V -S dashboard.cmake

  build-linux-python-packages:
    runs-on: ubuntu-24.04
    strategy:
      max-parallel: 2
      matrix:
        python-version: ["39", "310", "311","312","313"]

    steps:
    - uses: actions/checkout@v4.2.2

    - name: 'Free up disk space'
      run: |
        # Workaround for https://github.com/actions/virtual-environments/issues/709
        df -h
        sudo apt-get clean
        sudo rm -rf "/usr/local/share/boost"
        sudo rm -rf "$AGENT_TOOLSDIRECTORY"
        df -h

    - name: 'Fetch build dependencies'
      shell: bash
      run: |
        sudo apt install zstd
        unzstd --version

    - name: Set up Python 3.11
      uses: actions/setup-python@v5.4.0
      with:
        python-version: "3.11"

    - name: Get specific version of CMake, Ninja
      uses: lukka/get-cmake@v3.31.5

    - name: Evaluate template
      shell: bash
      run: |
        python -m pip install cookiecutter
        python -m cookiecutter --no-input --output-dir "${GITHUB_WORKSPACE}/Evaluated" "${GITHUB_WORKSPACE}"
        mkdir "${GITHUB_WORKSPACE}/Evaluated/ITKModuleTemplate/.git"

    - name: 'Fetch build script'
      run: |
        curl -L https://raw.githubusercontent.com/InsightSoftwareConsortium/ITKPythonPackage/${{ env.itk-python-package-tag }}/scripts/dockcross-manylinux-download-cache-and-build-module-wheels.sh -O
        chmod u+x dockcross-manylinux-download-cache-and-build-module-wheels.sh

    - name: 'Build 🐍 Python 📦 package'
      run: |
        cd "${GITHUB_WORKSPACE}/Evaluated/ITKModuleTemplate"
        export ITK_PACKAGE_VERSION=${{ env.itk-wheel-tag }}
        export ITKPYTHONPACKAGE_TAG=${{ env.itk-python-package-tag }}
        for manylinux_version in "_2_28" "2014"; do
          rm -rf ITKPythonPackage
          export MANYLINUX_VERSION=${manylinux_version}
          echo "Building for manylinux specialization ${MANYLINUX_VERSION}"
          ../../dockcross-manylinux-download-cache-and-build-module-wheels.sh cp${{ matrix.python-version }}
        done

    - name: Publish Python package as GitHub Artifact
      uses: actions/upload-artifact@v4.6.0
      with:
        name: LinuxWheel3${{ matrix.python-version }}
        path: Evaluated/ITKModuleTemplate/dist

  build-macos-python-packages:
    runs-on: macos-13
    strategy:
      max-parallel: 2
      matrix:
        python3-minor-version: ["9", "10", "11", "12", "13"]

    steps:
    - uses: actions/checkout@v4.2.2

    - name: 'Specific XCode version'
      run: |
        sudo xcode-select -s "/Applications/Xcode_14.3.1.app"

    - name: Get specific version of CMake, Ninja
      uses: lukka/get-cmake@v3.31.5

    - name: 'Fetch build script'
      run: |
        curl -L https://raw.githubusercontent.com/InsightSoftwareConsortium/ITKPythonPackage/${{ env.itk-python-package-tag }}/scripts/macpython-download-cache-and-build-module-wheels.sh -O
        chmod u+x macpython-download-cache-and-build-module-wheels.sh

    - name: Set up Python 3.11
      uses: actions/setup-python@v5.4.0
      with:
        python-version: "3.11"

    - name: Evaluate template
      shell: bash
      run: |
        python -m pip install cookiecutter
        python -m cookiecutter --no-input --output-dir "${GITHUB_WORKSPACE}/Evaluated" "${GITHUB_WORKSPACE}"
        mkdir "${GITHUB_WORKSPACE}/Evaluated/ITKModuleTemplate/.git"

    - name: 'Build 🐍 Python 📦 package'
      run: |
        cd "${GITHUB_WORKSPACE}/Evaluated/ITKModuleTemplate"
        export ITK_PACKAGE_VERSION=${{ env.itk-wheel-tag }}
        export ITKPYTHONPACKAGE_TAG=${{ env.itk-python-package-tag }}
        export ITKPYTHONPACKAGE_ORG=${{ env.itk-python-package-org }}
        # For Xcode 16.2, the recommended "MACOSX_DEPLOYMENT_TARGET" is "13.0"; this means your application should be built to run on macOS Ventura (version 13.0) or later. 
        export MACOSX_DEPLOYMENT_TARGET=${{ matrix.deployment_target || '13.0' }}
        ../../macpython-download-cache-and-build-module-wheels.sh "3.${{ matrix.python3-minor-version }}"

    - name: Publish Python package as GitHub Artifact
      uses: actions/upload-artifact@v4.6.0
      with:
        name: MacOSWheel3${{ matrix.python3-minor-version }}
        path: Evaluated/ITKModuleTemplate/dist

  build-windows-python-packages:
    runs-on: windows-2022
    strategy:
      max-parallel: 2
      matrix:
        python-version-minor: ["9", "10", "11"]

    steps:
    - uses: actions/checkout@v4.2.2

    - name: 'Install Python'
      run: |
        $pythonArch = "64"
        $pythonVersion = "3.${{ matrix.python-version-minor }}"
        iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/scikit-build/scikit-ci-addons/master/windows/install-python.ps1'))

    - uses: actions/setup-python@v5.4.0
      with:
        python-version: '3.x'

    - name: Get specific version of CMake, Ninja
      uses: lukka/get-cmake@v3.31.5

    - name: Set up Python 3.11/
      uses: actions/setup-python@v5.4.0
      with:
        python-version: "3.11"

    - name: Evaluate template
      shell: bash
      run: |
        python -m pip install cookiecutter
        python -m cookiecutter --no-input --output-dir "${GITHUB_WORKSPACE}/Evaluated" "${GITHUB_WORKSPACE}"
        mkdir "${GITHUB_WORKSPACE}/Evaluated/ITKModuleTemplate/.git"

    - name: 'Fetch build dependencies'
      shell: bash
      run: |
        cd Evaluated/ITKModuleTemplate
        curl -L "https://github.com/InsightSoftwareConsortium/ITKPythonBuilds/releases/download/${{ env.itk-wheel-tag }}/ITKPythonBuilds-windows.zip" -o "ITKPythonBuilds-windows.zip"
        7z x ITKPythonBuilds-windows.zip -o/c/P -aoa -r
        curl -L "https://data.kitware.com/api/v1/file/5c0ad59d8d777f2179dd3e9c/download" -o "doxygen-1.8.11.windows.bin.zip"
        7z x doxygen-1.8.11.windows.bin.zip -o/c/P/doxygen -aoa -r
        curl -L "https://data.kitware.com/api/v1/file/5bbf87ba8d777f06b91f27d6/download/grep-win.zip" -o "grep-win.zip"
        7z x grep-win.zip -o/c/P/grep -aoa -r

        # Update step for skbuild issue in v5.3.0 build archive
        echo "Updating ITKPythonPackage build scripts to ${{ env.itk-python-package-tag }}"
        pushd /c/P/IPP
        git remote add InsightSoftwareConsortium https://github.com/InsightSoftwareConsortium/ITKPythonPackage.git --tags
        git fetch InsightSoftwareConsortium
        git checkout ${{ env.itk-python-package-tag }}
        git status
        popd

    - name: 'Build 🐍 Python 📦 package'
      shell: cmd
      run: |
        cd Evaluated/ITKModuleTemplate
        call "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Auxiliary\Build\vcvars64.bat"
        set PATH=C:\P\grep;%PATH%
        set CC=cl.exe
        set CXX=cl.exe
        C:\Python3${{ matrix.python-version-minor }}-x64\python.exe C:\P\IPP\scripts\windows_build_module_wheels.py --py-envs "3${{ matrix.python-version-minor }}-x64"

    - name: Publish Python package as GitHub Artifact
      uses: actions/upload-artifact@v4.6.0
      with:
        name: WindowsWheel3.${{ matrix.python-version-minor }}
        path: Evaluated/ITKModuleTemplate/dist