push-master.yml

name: HyperHDR CI Build

on:
  push:
  pull_request:

env:
    USE_CACHE: ${{ vars.USE_CACHE && vars.USE_CACHE || true }}
    RESET_CACHE: ${{ vars.RESET_CACHE && vars.RESET_CACHE || false }}
    USE_CODEQL: ${{ vars.USE_CODEQL && vars.USE_CODEQL || false }}
    BUILD_ARCHIVES: ${{ startsWith(github.event.ref, 'refs/tags') && true || false }}

jobs:

######################
###### Linux #########
######################

  Linux:
    name: ${{ matrix.architecture }}/${{ matrix.distroName}}:${{ matrix.distroVersion }}
    runs-on: ${{ startsWith(matrix.architecture, 'arm') && 'ubuntu-24.04-arm' || 'ubuntu-24.04' }}
    env:
      platform: ${{ startsWith(matrix.architecture, 'arm') && 'rpi' || 'linux' }}
    strategy:      
      matrix:
        distroName: [debian]
        distroVersion: [bullseye, bookworm, trixie]
        architecture: [amd64, armhf, arm64]        
        include:
          - distroName: ubuntu
            distroVersion: noble
            architecture: amd64
          - distroName: ubuntu
            distroVersion: resolute
            architecture: amd64
          - distroName: fedora
            distroVersion: 44
            architecture: amd64
          - distroName: archlinux
            distroVersion: latest
            architecture: amd64

    steps:   
      - uses: actions/checkout@v6.0.2
        with:
          submodules: true

      - name: Download ccache files
        if: env.USE_CACHE == 'true'
        uses: actions/cache@v5.0.4
        with:
           path: .ccache
           key: ${{ matrix.architecture }}-${{ matrix.distroName }}-${{ matrix.distroVersion }}-ccache-${{ github.run_id }}
           restore-keys: ${{ matrix.architecture }}-${{ matrix.distroName }}-${{ matrix.distroVersion }}-ccache-

      - name: Check default version
        if: matrix.distroVersion != 'bullseye'
        run: |
          echo "USE_STANDARD_INSTALLER_NAME=true" >> $GITHUB_ENV

      - name: Build packages
        env:
          ARCHITECTURE: ${{ matrix.architecture }}
          DISTRO_NAME: ${{ matrix.distroName }}
          DISTRO_VERSION: ${{ matrix.distroVersion }}
          PLATFORM: ${{ env.platform }}
          USE_CCACHE: ${{ env.USE_CACHE }}
          RESET_CACHE: ${{ env.RESET_CACHE }}
        shell: bash
        run: |
          ./build.sh

      - name: Clear branch ccache storage
        if: startsWith(github.event.ref, 'refs/tags') == false
        continue-on-error: true
        run: |
          gh cache list --ref "${{ github.ref }}" --key "${{ matrix.architecture }}-${{ matrix.distroName }}-${{ matrix.distroVersion }}-ccache-" --limit 100 --json id --jq '.[].id' | xargs -r -n1 gh cache delete
        env:
          GH_TOKEN: ${{ github.token }}

      - name: Upload artifacts (release)
        if: startsWith(github.event.ref, 'refs/tags') && github.event_name != 'pull_request'
        uses: actions/upload-artifact@v7.0.0
        with:
          name: release-artifact-${{ matrix.architecture }}-${{ matrix.distroName }}-${{ matrix.distroVersion }}
          path: deploy/Hyper*

      - name: Upload artifacts from commit
        if: startsWith(github.event.ref, 'refs/tags') == false && github.event_name != 'pull_request'
        uses: actions/upload-artifact@v7.0.0
        with:
          name: Linux-${{ matrix.architecture }}-${{ matrix.distroName }}-${{ matrix.distroVersion }}-installer
          path: |
            deploy/Hyper*.deb
            deploy/Hyper*.zst
            deploy/Hyper*.rpm

######################
######## macOS #######
######################

  macOS:
    name: ${{ matrix.JOB_NAME }}
    runs-on: ${{ matrix.JOB_RUNNER }}
    strategy:
      matrix:
        include:        
          - JOB_RUNNER: macos-15
            JOB_NAME: "macOS 15 (arm64: M1/M2/M3/M4)"
            NICE_NAME: arm64
          - JOB_RUNNER: macos-15-intel
            JOB_NAME: macOS 15 (x64)
            NICE_NAME: x64
    steps:
      # Checkout
      - uses: actions/checkout@v6.0.2
        with:
            submodules: true

      - name: Download ccache files
        if: env.USE_CACHE == 'true'
        uses: actions/cache@v5.0.4
        with:
            path: build/.ccache
            key: macOS-${{ matrix.NICE_NAME }}-ccache-${{ github.run_id }}
            restore-keys: macOS-${{ matrix.NICE_NAME }}-ccache

      # Install deps
      - name: Install deps
        shell: bash
        run: brew install -q qtbase qtserialport ccache zstd webp jpeg-turbo flatbuffers pkg-config || true
            
      - name: Build packages
        env:
            PLATFORM: osx
            USE_CCACHE: ${{ env.USE_CACHE }}
            RESET_CACHE: ${{ env.RESET_CACHE }}
            JOB_RUNNER: ${{ matrix.JOB_RUNNER }}
        shell: bash
        run: ./build.sh || ./build.sh

      - name: Clear branch ccache storage
        continue-on-error: true
        run: |
          gh cache list --ref "${{ github.ref }}" --key "macOS-${{ matrix.NICE_NAME }}-ccache" --limit 100 --json id --jq '.[].id' | xargs -r -n1 gh cache delete
        env:
          GH_TOKEN: ${{ github.token }}

      - name: Upload artifacts (release)
        if: startsWith(github.event.ref, 'refs/tags') && github.event_name != 'pull_request'
        uses: actions/upload-artifact@v7.0.0
        with:
            name: release-artifact-${{ matrix.JOB_RUNNER }}      
            path: build/Hyper*.dmg

      - name: Upload artifacts from commit
        if: startsWith(github.event.ref, 'refs/tags') == false && github.event_name != 'pull_request'
        uses: actions/upload-artifact@v7.0.0
        with:
            name: Apple_macOS_${{ matrix.NICE_NAME }}_DMG_installer
            path: build/Hyper*.dmg

######################
###### Windows #######
######################

  windows:
    name: Windows
    runs-on: windows-2025
    env:
      MSVC: 2022
      QT_VERSION: 6.8.3
      TOOLKIT_DIR: "${{ github.workspace }}\\Toolkit"
    steps:
      - name: Checkout
        uses: actions/checkout@v6.0.2
        with:
          submodules: true

      - name: Cache Toolkit
        uses: actions/cache@v5.0.4
        id: cache-toolkit-windows
        with:
          path: ${{ env.TOOLKIT_DIR }}
          key: ${{ runner.os }}-Toolkit-Qt.${{ env.QT_VERSION }}-NSIS-TurboJPEG

      - name: Python 3.13 for aqtinstall
        if: steps.cache-toolkit-windows.outputs.cache-hit != 'true'
        uses: actions/setup-python@v6      
        with:
          python-version: '3.13'

      - name: "Install Toolkit: Qt, TurboJPEG and NSIS"
        if: steps.cache-toolkit-windows.outputs.cache-hit != 'true'
        shell: powershell
        run: |          
          Invoke-WebRequest -Method Get -Uri https://github.com/libjpeg-turbo/libjpeg-turbo/releases/download/3.0.3/libjpeg-turbo-3.0.3-vc64.exe -OutFile turbojpeg.exe -UseBasicParsing
          Start-Process -Wait turbojpeg.exe -ArgumentList "/S","/D=$env:TOOLKIT_DIR\libjpeg-turbo64"
          Invoke-WebRequest -UserAgent "Wget" -Uri "https://prdownloads.sourceforge.net/nsis/nsis-3.11-setup.exe" -OutFile nsis.exe
          Start-Process -Wait nsis.exe -ArgumentList "/S","/D=$env:TOOLKIT_DIR\nsis"
          New-Item -ItemType Directory -Force -Path "$env:TOOLKIT_DIR\ccache" | Out-Null
          Invoke-WebRequest -Method Get -Uri https://github.com/ccache/ccache/releases/download/v4.12/ccache-4.12-windows-x86_64.zip -OutFile "$env:TOOLKIT_DIR\ccache\ccache.zip" -UseBasicParsing
          pip install aqtinstall
          aqt install-qt -O "$env:TOOLKIT_DIR\Qt" windows desktop $env:QT_VERSION "win64_msvc${env:MSVC}_64" -m qtserialport

      - name: "Restore Toolkit"
        shell: cmd
        run: |
          7z e "%TOOLKIT_DIR%\ccache\ccache.zip" -o.\build *.exe -r
          echo %TOOLKIT_DIR%\nsis>> %GITHUB_PATH%

      - name: Download ccache files
        if: env.USE_CACHE == 'true'
        uses: actions/cache@v5.0.4
        with:
            path: build/.ccache
            key: ${{ runner.os }}-ccache-${{ github.run_id }}
            restore-keys: ${{ runner.os }}-ccache
          
      - name: Build packages        
        env:
          PLATFORM: windows
          VCINSTALLDIR: 'C:/Program Files/Microsoft Visual Studio/${{ env.MSVC }}/Enterprise/VC'
          CMAKE_PREFIX_PATH: "${{ env.TOOLKIT_DIR }}\\Qt\\${{ env.QT_VERSION }}\\msvc${{ env.MSVC }}_64\\lib\\cmake\\"
          USE_CCACHE: ${{ env.USE_CACHE }}
        shell: bash
        run: |
          "${{env.VCINSTALLDIR}}/Auxiliary/Build/vcvars64.bat"
          ./build.sh

      - name: Clear branch ccache storage
        continue-on-error: true
        run: |
          gh cache list --ref "${{ github.ref }}" --key "${{ runner.os }}-ccache" --limit 100 --json id --jq '.[].id' | xargs -r -n1 gh cache delete
        env:
          GH_TOKEN: ${{ github.token }}

      - name: Upload artifacts (release)
        if: startsWith(github.event.ref, 'refs/tags') && github.event_name != 'pull_request'
        uses: actions/upload-artifact@v7.0.0
        with:
          name: release-artifact-windows
          path: build/Hyper*
          
      - name: Upload artifacts from commit
        if: startsWith(github.event.ref, 'refs/tags') == false && github.event_name != 'pull_request'
        uses: actions/upload-artifact@v7.0.0
        with:
          name: Windows_x64_setup
          path: build/Hyper*.exe

################################
####### CodeQL support #########
################################

  analyze:
    name: Analyze (CodeQL)
    runs-on: ubuntu-latest
    if: ${{ vars.USE_CODEQL == 'true' && vars.USE_CODEQL || false }}

    permissions:
      actions: read
      contents: read
      security-events: write

    strategy:
      fail-fast: false
      matrix:
        language: [ 'cpp', 'javascript' ]

    steps:
      - name: Checkout repository
        uses: actions/checkout@v6.0.2
        if: env.USE_CODEQL == 'true'
        with:
          submodules: true

      - name: Run composite CodeQL job for '${{matrix.language}}' language
        uses: ./.github/actions/codeql
        if: env.USE_CODEQL == 'true'
        with:
          language: ${{matrix.language}}

#########################################
####### Static C++20/QT analyze #########
#########################################

  clang-tidy-clazy:
    name: Analyze (clang and clazy)
    runs-on: ubuntu-latest
    if: ${{ vars.USE_CODEQL == 'true' && vars.USE_CODEQL && false || false }}

    permissions:
      contents: read
      pull-requests: write

    steps:
      - name: Checkout repo
        uses: actions/checkout@v6.0.2
        with:
          submodules: true

      - name: Install dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y pandoc jq clang clang-tidy clang-tools clazy build-essential cmake flatbuffers-compiler git libasound2-dev libayatana-appindicator3-dev libegl-dev libflatbuffers-dev libftdi1-dev libgl-dev libglvnd-dev libgtk-3-dev liblzma-dev libpipewire-0.3-dev libssl-dev libsystemd-dev libturbojpeg0-dev libusb-1.0-0-dev libx11-dev libzstd-dev ninja-build patchelf pkg-config python3 qt6-serialport-dev qt6-base-dev unzip wget

      - name: Configure (CMake with Makefiles)
        run: |
          cmake -S . -B build \
            -DUSE_PRECOMPILED_HEADERS=OFF \
            -DUSE_CCACHE_CACHING=OFF \
            -DCMAKE_CXX_COMPILER=clang++ \
            -DCMAKE_C_COMPILER=clang \
            -DCMAKE_EXPORT_COMPILE_COMMANDS=ON

      - name: Build project
        run: cmake --build build --parallel $(nproc)

      - name: Run clazy
        run: |
          jq -r '.[] | .file' build/compile_commands.json | tr '\n' '\0' | xargs -0 clazy-standalone -p build -ignore-dirs "/external/|_deps/" 2>&1 | sed "/warning: argument unused during compilation: '-fuse-ld=gold'/d; /\[-Wclazy-const-signal-or-slot\]/,/^[[:space:]]*\^/d; /\[-Wclazy-qstring-arg\]/,/^[[:space:]]*\^/d; /\[-Wclazy-skipped-base-method\]/,/^[[:space:]]*\^/d" | sed '/^In file included from/d; /^[0-9]\+ warning.* generated\./d' > clazy-report.txt || true

      - name: Run clang-tidy
        run: |
          jq -r '.[] | select(.file | test("external/|_deps/|/mocs_") | not) | .file' build/compile_commands.json | xargs run-clang-tidy -p build -quiet | awk 'BEGIN{b=""}/: warning:/{if(b!=""&&!s)printf"%s",b;b="";s=0;c=$0~/(pass-by-value|value-param)/;l="";nx=0}{b=b$0"\n";if(c){if(nx){if(substr($0,idx)~/^Q[A-Z][a-zA-Z0-9]*/)s=1;nx=0}if($0~/^[ \t]*\|?[ \t]*\^/){idx=index($0,"^");if(substr(l,idx)~/^(const[ \t]+)?Q[A-Z][a-zA-Z0-9]*/)s=1;nx=1}if($0~/^[ \t]*[0-9]+ \|/)l=$0}}END{if(b!=""&&!s)printf"%s",b}' > clang-tidy-report.txt || true
#          jq -r '.[] | select(.file | test("external/|_deps/|autogen|mocs_|qrc_") | not) | .file' build/compile_commands.json | xargs run-clang-tidy -p build -quiet -config="$(cat .clang-tidy-fix)" -fix > clang-tidy-fix.log 2>&1 || true
      - name: Combine reports
        run: |
          echo "### Clang-Tidy Report" > report.md
          echo "\`\`\`" >> report.md
          cat clang-tidy-report.txt >> report.md
          echo "\`\`\`" >> report.md
          echo "" >> report.md
          echo "### Clazy Report" >> report.md
          echo "\`\`\`" >> report.md
          cat clazy-report.txt >> report.md
          echo "\`\`\`" >> report.md

      - name: Convert report to HTML
        run: |
          pandoc report.md -f markdown -t html -s -o cpp_report.html

      - name: Upload report artifact
        uses: actions/upload-artifact@v7.0.0
        with:
          name: static-cpp-analysis-report
          path: |
            cpp_report.html
            clang-tidy-report.txt
            clazy-report.txt

################################
###### Publish Releases ########
################################

  publish:
    name: Publish Releases
    if: startsWith(github.event.ref, 'refs/tags') && github.event_name != 'pull_request'
    needs: [Linux, windows, macOS]
    runs-on: ubuntu-24.04
    permissions:
      contents: write
    steps:
      - name: Checkout
        uses: actions/checkout@v6.0.2

      - name: Generate environment variables from version and tag
        run: |
          echo "TAG=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
          echo "VERSION=$(tr -d '\n' < version)" >> $GITHUB_ENV
          echo "preRelease=false" >> $GITHUB_ENV

      - name: Mark release as pre-release
        if: contains(env.VERSION, 'alpha') || contains(env.VERSION, 'beta')
        run: echo "preRelease=true" >> $GITHUB_ENV

      - name: Download artifacts
        uses: actions/download-artifact@v8.0.1
        with:
          path: artifacts
          pattern: release-artifact-*
          merge-multiple: true          

      - name: Create draft release
        uses: softprops/action-gh-release@v2.6.1
        with:
          name: HyperHDR ${{ env.VERSION }}
          tag_name: ${{ env.TAG }}
          files: "artifacts/**"
          draft: true
          prerelease: ${{ env.preRelease }}