name: CMake Build for Doxygen on: [push, pull_request] jobs: build: permissions: contents: write # to push pages branch (peaceiris/actions-gh-pages) name: ${{ matrix.config.name }} runs-on: ${{ matrix.config.os }} strategy: fail-fast: false matrix: config: - { name: "Ubuntu Latest GCC Release (Intel)", os: ubuntu-24.04, build_type: "Release", cc: "gcc", cxx: "g++", build_gen: "Unix Makefiles", cmake_extra_opts: "-Dbuild_search=YES -Dbuild_app=YES -Dbuild_parse=YES" } - { name: "Ubuntu Latest GCC Debug (Intel)", os: ubuntu-24.04, build_type: "Debug", cc: "gcc", cxx: "g++", build_gen: "Unix Makefiles", cmake_extra_opts: "-Dbuild_search=YES -Dbuild_app=YES -Dbuild_parse=YES" } - { name: "Ubuntu Latest Clang Release (Intel)", os: ubuntu-24.04, build_type: "Release", cc: "clang", cxx: "clang++", build_gen: "Unix Makefiles", cmake_extra_opts: "-Duse_libclang=YES -Dstatic_libclang=YES -Duse_libc++=NO" } - { name: "Ubuntu Latest Clang Debug (Intel)", os: ubuntu-24.04, build_type: "Debug", cc: "clang", cxx: "clang++", build_gen: "Unix Makefiles", cmake_extra_opts: "-Duse_libclang=YES -Dstatic_libclang=YES -Duse_libc++=NO" } - { name: "Ubuntu Latest GCC Release (Arm)", os: ubuntu-24.04-arm, build_type: "Release", cc: "gcc", cxx: "g++", build_gen: "Unix Makefiles", cmake_extra_opts: "-Dbuild_search=YES -Dbuild_app=YES -Dbuild_parse=YES" } - { name: "Ubuntu Latest GCC Debug (Arm)", os: ubuntu-24.04-arm, build_type: "Debug", cc: "gcc", cxx: "g++", build_gen: "Unix Makefiles", cmake_extra_opts: "-Dbuild_search=YES -Dbuild_app=YES -Dbuild_parse=YES" } - { name: "Ubuntu Latest Clang Release (Arm)", os: ubuntu-24.04-arm, build_type: "Release", cc: "clang", cxx: "clang++", build_gen: "Unix Makefiles", cmake_extra_opts: "-Duse_libclang=YES -Dstatic_libclang=YES -Duse_libc++=NO" } - { name: "Ubuntu Latest Clang Debug (Arm)", os: ubuntu-24.04-arm, build_type: "Debug", cc: "clang", cxx: "clang++", build_gen: "Unix Makefiles", cmake_extra_opts: "-Duse_libclang=YES -Dstatic_libclang=YES -Duse_libc++=NO" } - { name: "macOS Latest Release (Intel)", os: macos-14, build_type: "Release", cc: "clang", cxx: "clang++", build_gen: "Unix Makefiles" } - { name: "macOS Latest Debug (Intel)", os: macos-14, build_type: "Debug", cc: "clang", cxx: "clang++", build_gen: "Unix Makefiles" } - { name: "macOS Latest Release (Apple Silicon)", os: macos-14, build_type: "Release", cc: "clang", cxx: "clang++", build_gen: "Unix Makefiles" } - { name: "macOS Latest Debug (Apple Silicon)", os: macos-14, build_type: "Debug", cc: "clang", cxx: "clang++", build_gen: "Unix Makefiles" } - { name: "Windows Latest MSVC Debug", os: windows-latest, build_type: "Debug", cc: "cl", cxx: "cl", build_gen: "NMake Makefiles" } - { name: "Windows Latest MSVC Release", os: windows-latest, build_type: "Release", cc: "cl", cxx: "cl", build_gen: "NMake Makefiles" } steps: - name: Checkout doxygen uses: actions/checkout@v5 with: fetch-depth: 0 - name: Install libiconv (Windows) uses: suisei-cn/actions-download-file@v1 with: url: "https://github.com/pffang/libiconv-for-Windows/releases/download/v1.16/libiconv-for-Windows_1.16.7z" target: . if: matrix.config.os == 'windows-latest' - name: Install LaTeX (Linux) run: | # workaround to avoid hanging on restarting the snapd after installing the firefox snap sudo snap remove --purge firefox sudo snap remove --purge snapd sudo apt remove -y --purge snapd sudo apt-mark hold snapd # end workaround sudo apt update --fix-missing sudo apt upgrade sudo apt update sudo apt-get install texlive texlive-latex-recommended texlive-extra-utils texlive-latex-extra texlive-font-utils if: startsWith(matrix.config.os,'ubuntu-') - name: Install LaTeX (MacOS) run: | brew update || true brew install --cask mactex || true echo "/Library/TeX/texbin/" >> $GITHUB_PATH if: startsWith(matrix.config.os,'macos-') - name: Install libclang (Ubuntu 24.04) run: | sudo apt update sudo apt remove llvm-14 llvm-14-dev llvm-14-tools llvm-14-runtime clang-14 clang-format-14 libclang-common-14-dev libclang-cpp14 libclang1-14 libllvm14 sudo apt remove llvm-15 llvm-15-dev llvm-15-tools llvm-15-runtime clang-15 clang-format-15 libclang-common-15-dev libclang-cpp15 libclang1-15 libllvm15 sudo apt remove llvm-16 llvm-16-dev llvm-16-tools llvm-16-runtime clang-16 clang-format-16 libclang-common-16-dev libclang-cpp16 libclang1-16 libllvm16 sudo apt remove llvm-17 llvm-17-dev llvm-17-tools llvm-17-runtime clang-17 clang-format-17 libclang-common-17-dev libclang-cpp17 libclang1-17 libllvm17 sudo apt-get autoremove sudo apt-get clean sudo apt install -y libclang-common-18-dev libclang-18-dev clang-18 llvm-18 llvm-18-dev apt list --installed | egrep '(clang|llvm)' ls -d /usr/lib/llvm-*/include/ sudo update-alternatives --install /usr/bin/clang clang /usr/bin/clang-18 100 sudo update-alternatives --install /usr/bin/clang++ clang++ /usr/bin/clang++-18 100 ls -al /usr/bin/clang++ ls -al /etc/alternatives/clang++ which clang++ clang++ -v if: matrix.config.cc == 'clang' && startsWith(matrix.config.os,'ubuntu-24') - name: Install libxapian (Ubuntu 24.04) run: | sudo apt update sudo apt install libxapian-dev if: startsWith(matrix.config.os,'ubuntu-24') - name: Install MikTeX (Windows) uses: nick-invision/retry@v3 with: timeout_minutes: 15 max_attempts: 5 retry_wait_seconds: 60 command: | choco install miktex --debug --verbose --no-progress --params "/Set:basic" -y if ($?) { echo "C:\Program Files\MiKTeX\miktex\bin\x64" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 } if: matrix.config.os == 'windows-latest' - name: Configure MikTeX (Windows) run: | miktex --admin --verbose packages update-package-database miktex --admin --verbose packages update miktex --admin --verbose fndb refresh initexmf --admin --verbose --set-config-value=[MPM]AutoInstall=1 initexmf --admin --verbose --update-fndb initexmf --admin --verbose --mklinks --force updmap --admin if: matrix.config.os == 'windows-latest' - name: Install Ghostscript (Linux) run: | sudo apt update sudo apt-get install ghostscript if: startsWith(matrix.config.os,'ubuntu-') - name: Install Ghostscript (Windows) run: choco install ghostscript if: matrix.config.os == 'windows-latest' - name: Setting Ghostscript paths (Windows) shell: bash run: | export GSpath=`find /c/Prog*/gs -name gswin\*c.exe | sed -e "s/gswin.*c.exe//"` export PATH="$GSpath:$PATH" export GSpath=`echo "$GSpath" | sed -e "s%/c%C:%"` echo "$GSpath" >> $GITHUB_PATH if: matrix.config.os == 'windows-latest' - name: Install xmllint (Linux) run: | sudo apt-get update sudo apt-get install libxml2-utils if: startsWith(matrix.config.os,'ubuntu-') - name: Install xmllint (MacOS) run: | brew update || true brew upgrade || true brew install libxml2 if: startsWith(matrix.config.os,'macos-') - name: Install bison (MacOS) run: | brew update brew install bison; echo "$(brew --prefix bison)/bin" >> $GITHUB_PATH #echo "/usr/local/opt/bison/bin" >> $GITHUB_PATH if: startsWith(matrix.config.os,'macos-') - name: Install bison/flex (Windows) run: | #Choco-Install -PackageName winflexbison choco install winflexbison3 if: matrix.config.os == 'windows-latest' - name: Install Graphviz (Linux) run: | sudo apt update sudo apt-get install graphviz if: startsWith(matrix.config.os,'ubuntu-') - name: Install Graphviz (MacOS) run: | if ! brew install graphviz; then # Workaround issue with unexpected symlinks: https://github.com/actions/runner-images/issues/6817 for f in 2to3 idle3 pydoc3 python3 python3-config; do rm /usr/local/bin/$f || true done # Try again brew install graphviz fi if: startsWith(matrix.config.os,'macos-') - name: Install Graphviz (Windows) run: choco install graphviz.portable if: matrix.config.os == 'windows-latest' - name: Setup VS Environment (Windows) uses: seanmiddleditch/gha-setup-vsdevenv@master if: matrix.config.os == 'windows-latest' - name: Refresh Env (Windows) run: | Import-Module $env:ChocolateyInstall\helpers\chocolateyProfile.psm1 refreshenv if: matrix.config.os == 'windows-latest' - name: Install Qt 6.8 uses: jdpurcell/install-qt-action@v5 with: version: 6.8.* if: matrix.config.os == 'ubuntu-24.04-arm' - name: Install Qt 6.2 uses: jdpurcell/install-qt-action@v5 with: version: 6.2.* if: startsWith(matrix.config.os,'macos-') - name: Install Qt 5 uses: jdpurcell/install-qt-action@v5 with: version: 5.* if: startsWith(matrix.config.os,'macos-')!=true && matrix.config.os != 'ubuntu-24.04-arm' - name: Check tool versions (Linux / MacOS) shell: bash run: | echo "=== perl ==="; perl --version; echo "=== python ==="; python --version; echo "=== cmake ==="; cmake --version; echo "=== latex ==="; latex --version; echo "=== bibtex ==="; bibtex --version echo "=== dvips ==="; dvips --version echo "=== bison ==="; bison --version; echo "=== flex ==="; flex --version; echo "=== dot ==="; dot -V; echo "=== ghostscript ==="; gs --version; if: matrix.config.os != 'windows-latest' - name: Check tool versions (Windows) shell: bash run: | echo "=== perl ==="; perl --version; echo "=== python ==="; python --version; echo "=== cmake ==="; cmake --version; echo "=== latex ==="; latex --version; echo "=== bibtex ==="; bibtex --version echo "=== dvips ==="; dvips --version echo "=== bison ==="; win_bison --version; echo "=== flex ==="; win_flex --version; echo "=== dot ==="; dot -V; echo "=== ghostscript ==="; gswin64c --version; if: matrix.config.os == 'windows-latest' - name: Configure shell: cmake -P {0} run: | set(ENV{CC} ${{ matrix.config.cc }}) set(ENV{CXX} ${{ matrix.config.cxx }}) execute_process( COMMAND cmake -S . -B build -D CMAKE_BUILD_TYPE=${{ matrix.config.build_type }} -G "${{ matrix.config.build_gen }}" -Dbuild_doc=YES -Dbuild_wizard=YES ${{ matrix.config.cmake_extra_opts }} RESULT_VARIABLE result ) if (NOT result EQUAL 0) message(FATAL_ERROR "Bad exit status") endif() - name: Build shell: cmake -P {0} run: | include(ProcessorCount) ProcessorCount(N) execute_process( COMMAND cmake --build build --parallel ${N} RESULT_VARIABLE result OUTPUT_VARIABLE output ERROR_VARIABLE output ECHO_OUTPUT_VARIABLE ECHO_ERROR_VARIABLE ) if (NOT result EQUAL 0) string(REGEX MATCH "FAILED:.*$" error_message "${output}") string(REPLACE "\n" "%0A" error_message "${error_message}") message("::error::${error_message}") message(FATAL_ERROR "Build failed") endif() - name: Archive build artifacts uses: actions/upload-artifact@v4 with: name: "${{ matrix.config.name }} build artifacts" path: build/bin/ - name: Run tests (Linux / MacOS) shell: cmake -P {0} run: | set(ENV{CTEST_OUTPUT_ON_FAILURE} "ON") execute_process( COMMAND cmake -E env TEST_FLAGS="--xml --xmlxsd --xhtml --qhp --docbook --rtf --man" cmake --build build --target tests RESULT_VARIABLE result ) if (NOT result EQUAL 0) message(FATAL_ERROR "Running tests failed!") endif() if: matrix.config.os != 'windows-latest' - name: Run tests (Windows) shell: cmake -P {0} run: | set(ENV{CTEST_OUTPUT_ON_FAILURE} "ON") execute_process( COMMAND cmake -E env TEST_FLAGS="--xml --xmlxsd --xhtml --qhp --docbook --rtf --man --pdf" cmake --build build --target tests RESULT_VARIABLE result ) if (NOT result EQUAL 0) message(FATAL_ERROR "Running tests failed!") endif() if: matrix.config.os == 'windows-latest' - name: Generate documentation shell: cmake -P {0} run: | execute_process( COMMAND cmake --build build --target docs RESULT_VARIABLE result ) if (NOT result EQUAL 0) message(FATAL_ERROR "Building documentation failed") endif() - name: Archive html documentation artifacts uses: actions/upload-artifact@v4 with: name: "Html documentation artifacts" path: build/html/ if: matrix.config.name == 'Ubuntu Latest GCC Release (Intel)' - name: Archive Latex documentation artifacts uses: actions/upload-artifact@v4 with: name: "Latex documentation artifacts" path: build/latex/doxygen_manual.pdf if: matrix.config.name == 'Ubuntu Latest GCC Release (Intel)' - name: Generate Internal documentation shell: cmake -P {0} run: | execute_process( COMMAND cmake --build build --target docs_internal RESULT_VARIABLE result ) if (NOT result EQUAL 0) message(FATAL_ERROR "Building internal documentation failed") endif() if: matrix.config.name == 'Ubuntu Latest GCC Release (Intel)' - name: Publish Internal documentation to Github pages uses: peaceiris/actions-gh-pages@v4 with: deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} external_repository: doxygen/doxygen-docs publish_dir: build/doxygen_docs/html force_orphan: true if: ${{ github.event_name == 'push' && matrix.config.name == 'Ubuntu Latest GCC Release (Intel)' }}