From 7d2dce01c974f13215608103bbab5586558f60fe Mon Sep 17 00:00:00 2001 From: Andrei Shkrob Date: Wed, 12 Mar 2025 22:07:18 +0100 Subject: [PATCH] [ci] Create common workflow file for cmake build Signed-off-by: Andrei Shkrob --- .github/workflows/build-cmake.yaml | 187 ++++++++++++++++++++++++++ .github/workflows/coverage-check.yaml | 162 ---------------------- .github/workflows/linux-check.yaml | 186 ------------------------- .github/workflows/macos-check.yaml | 97 ------------- 4 files changed, 187 insertions(+), 445 deletions(-) create mode 100644 .github/workflows/build-cmake.yaml delete mode 100644 .github/workflows/coverage-check.yaml delete mode 100644 .github/workflows/linux-check.yaml delete mode 100644 .github/workflows/macos-check.yaml diff --git a/.github/workflows/build-cmake.yaml b/.github/workflows/build-cmake.yaml new file mode 100644 index 0000000000..296474bab5 --- /dev/null +++ b/.github/workflows/build-cmake.yaml @@ -0,0 +1,187 @@ +name: Build and Test CMake +on: + workflow_dispatch: # Manual trigger + push: + branches: + - master + pull_request: + paths-ignore: + - .gitignore + - .github/** + - '!.github/workflows/build-cmake.yaml' # Run check on self change + - CONTRIBUTORS + - LICENSE + - NOTICE + - README.md + - android/** + - iphone/** + - data/strings/** + - docs/** + - packaging/** + - pyhelpers/** + - tools/** + - '!tools/python/test_server/**' + - xcode/** + +# Cancels previous jobs if the same branch or PR was updated again. +concurrency: + group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} + cancel-in-progress: true + +jobs: + build: + strategy: + fail-fast: false + matrix: + cmake-build-type: [ Debug, RelWithDebInfo ] + environment: + - os: ubuntu-24.04 + cc: clang-18 + cxx: clang++-18 + disable-unity-build: ON + run-coverage: OFF + + - os: ubuntu-24.04 + cc: clang-18 + cxx: clang++-18 + disable-unity-build: OFF + run-coverage: OFF + + - os: ubuntu-24.04 + cc: clang-18 + cxx: clang++-18 + disable-unity-build: OFF + run-coverage: ON + + - os: ubuntu-24.04 + cc: gcc-14 + cxx: g++-14 + disable-unity-build: OFF + run-coverage: OFF + + - os: macos-15 + cc: clang + cxx: clang++ + disable-unity-build: OFF + run-coverage: OFF + exclude: + - environment: { run-coverage: ON } + cmake-build-type: RelWithDebInfo + + name: "${{ matrix.environment.os }} ${{ matrix.environment.cc }} ${{ matrix.cmake-build-type }} UnityDisable: ${{ matrix.environment.disable-unity-build }} Coverage: ${{ matrix.environment.run-coverage }}" + + runs-on: ${{ matrix.environment.os }} + + env: + BUILD_DIR: build + + steps: + # TODO: Is this step needed? + - name: Free disk space by removing .NET, Android and Haskell + if: ${{ runner.os == 'Linux' }} + run: sudo rm -rf /usr/share/dotnet /usr/local/lib/android /opt/ghc + + - name: Checkout sources + uses: actions/checkout@v4 + + - name: Parallel submodules checkout (Linux) + if: ${{ runner.os == 'Linux' }} + run: git submodule update --depth 1 --init --recursive --jobs=$(($(nproc) * 20)) + + - name: Parallel submodules checkout (macOS) + if: ${{ runner.os == 'macOS' }} + run: git submodule update --depth 1 --init --recursive --jobs=$(($(sysctl -n hw.logicalcpu) * 20)) + + - name: Install build tools and dependencies (Linux) + if: ${{ runner.os == 'Linux' }} + run: | + sudo apt update -y + sudo apt install -y \ + ninja-build \ + libgl1-mesa-dev \ + libglvnd-dev \ + libharfbuzz-dev \ + qt6-base-dev \ + libqt6svg6-dev \ + qt6-positioning-dev \ + libqt6positioning6-plugins \ + libqt6positioning6 + + - name: Install build tools and dependencies (macOS) + if: ${{ runner.os == 'macOS' }} + run: HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK=1 brew install ninja qt@6 + + - name: Install coverage check dependencies (Linux) + if: ${{ runner.os == 'Linux' && matrix.environment.run-coverage == 'ON' }} + run: sudo apt install -y llvm gcovr + + - name: Configure repository + run: ./configure.sh + + - name: Configure ccache + uses: hendrikmuhs/ccache-action@v1.2 + with: + key: ${{ github.workflow }}-${{ matrix.environment.os }}-${{ matrix.environment.cc }}-${{ matrix.environment.disable-unity-build }}-${{ matrix.environment.run-coverage }}-${{ matrix.cmake-build-type }} + + - name: Configure cmake + env: + CC: ${{ matrix.environment.cc }} + CXX: ${{ matrix.environment.cxx }} + CMAKE_C_COMPILER_LAUNCHER: ccache + CMAKE_CXX_COMPILER_LAUNCHER: ccache + run: | + cmake . -B ${{ env.BUILD_DIR }} -G Ninja \ + -DCMAKE_BUILD_TYPE=${{ matrix.cmake-build-type }} \ + -DCMAKE_C_FLAGS=-g1 \ + -DCMAKE_CXX_FLAGS=-g1 \ + -DUNITY_DISABLE=${{ matrix.environment.disable-unity-build }} \ + -DCOVERAGE_REPORT=${{ matrix.environment.run-coverage }} + + - name: Compile + working-directory: ${{ env.BUILD_DIR }} + run: ninja + + - name: Prepare testing environment (Linux) + if: ${{ runner.os == 'Linux' }} + run: | + sudo locale-gen en_US + sudo locale-gen en_US.UTF-8 + sudo locale-gen es_ES + sudo locale-gen es_ES.UTF-8 + sudo locale-gen fr_FR + sudo locale-gen fr_FR.UTF-8 + sudo locale-gen ru_RU + sudo locale-gen ru_RU.UTF-8 + sudo update-locale + + - name: Run tests + working-directory: ${{ env.BUILD_DIR }} + env: + QT_QPA_PLATFORM: "offscreen" + # generator_integration_tests - https://github.com/organicmaps/organicmaps/issues/225 + # opening_hours_integration_tests - https://github.com/organicmaps/organicmaps/issues/219 + # opening_hours_supported_features_tests - https://github.com/organicmaps/organicmaps/issues/219 + # routing_integration_tests - https://github.com/organicmaps/organicmaps/issues/221 + # shaders_tests - https://github.com/organicmaps/organicmaps/issues/223 + # world_feed_integration_tests - https://github.com/organicmaps/organicmaps/issues/215 + CTEST_EXCLUDE_REGEX: "generator_integration_tests|opening_hours_integration_tests|opening_hours_supported_features_tests|routing_benchmarks|routing_integration_tests|routing_quality_tests|search_quality_tests|storage_integration_tests|shaders_tests|world_feed_integration_tests" + run: ctest -L "omim-test" -E "$CTEST_EXCLUDE_REGEX" --output-on-failure + + - name: Run coverage report generation + if: ${{ matrix.environment.run-coverage == 'ON' }} + working-directory: ${{ env.BUILD_DIR }} + run: | + cmake --build . --target omim_coverage + cat coverage_report/summary.txt + + - name: Archive the coverage report + if: ${{ matrix.environment.run-coverage == 'ON' }} + working-directory: ${{ env.BUILD_DIR }}/coverage_report + run: zip -r coverage_report.zip html/ + + - name: Upload artifact + if: ${{ matrix.environment.run-coverage == 'ON' }} + uses: actions/upload-artifact@v4 + with: + name: coverage-report + path: build/coverage_report/coverage_report.zip diff --git a/.github/workflows/coverage-check.yaml b/.github/workflows/coverage-check.yaml deleted file mode 100644 index 833b5180fa..0000000000 --- a/.github/workflows/coverage-check.yaml +++ /dev/null @@ -1,162 +0,0 @@ -name: Coverage Report -on: - workflow_dispatch: # Manual trigger - pull_request: - types: - - opened - - synchronize - - labeled - - unlabeled - paths-ignore: - - .gitignore - - CONTRIBUTORS - - LICENSE - - NOTICE - - README.md - - docs/** - - packaging/** - - platform/*apple* - - platform/*_android* - - platform/*_ios* - - platform/*_mac* - - platform/*_win* - - pyhelpers/** - - tools/** - - '!tools/python/test_server/**' - - xcode/** - -# Cancels previous jobs if the same branch or PR was updated again. -concurrency: - group: ${{ github.workflow }}-coverage-${{ github.event.pull_request.number || github.ref }} - cancel-in-progress: true - -jobs: - should-run-check: - name: Should run coverage - runs-on: ubuntu-24.04 - outputs: - run-from-pr: ${{ steps.run-from-pr.outputs.run-from-pr }} - manually-triggered: ${{ steps.manually-triggered.outputs.manually-triggered }} - steps: - - name: Check if PR has 'Coverage' label - id: run-from-pr - if: github.event_name == 'pull_request' - env: - PR_NUMBER: ${{ github.event.pull_request.number }} - GH_TOKEN: ${{ github.token }} - run: | - LABEL_NAME="Coverage" - LABELS=$(gh pr view https://github.com/$GITHUB_REPOSITORY/pull/$PR_NUMBER --json labels) - if echo "$LABELS" | jq -e '.labels[].name' | grep -q "$LABEL_NAME"; then - echo "run-from-pr=true" >> $GITHUB_OUTPUT - echo "'Coverage' label found in PR." - fi - - name: Check if manually triggered - id: manually-triggered - if: github.event_name == 'workflow_dispatch' - run: echo "manually-triggered=true" >> $GITHUB_OUTPUT - - coverage: - needs: should-run-check - name: Generate coverage report - runs-on: ubuntu-24.04 - if: ${{ needs.should-run-check.outputs.run-from-pr == 'true' || needs.should-run-check.outputs.manually-triggered == 'true'}} - steps: - - name: Free disk space by removing .NET, Android and Haskell - shell: bash - run: | - sudo rm -rf /usr/share/dotnet /usr/local/lib/android /opt/ghc - - - name: Checkout sources - uses: actions/checkout@v4 - with: - fetch-depth: 100 # enough to get all commits for the current day - - - name: Parallel submodules checkout - shell: bash - run: git submodule update --depth 1 --init --recursive --jobs=$(($(nproc) * 20)) - - - name: Install build tools and dependencies - shell: bash - run: | - sudo apt update -y - sudo apt install -y \ - ninja-build \ - libgl1-mesa-dev \ - libglvnd-dev \ - qt6-base-dev \ - libfreetype-dev \ - libharfbuzz-dev \ - libqt6svg6-dev \ - qt6-positioning-dev \ - libqt6positioning6-plugins \ - libqt6positioning6 \ - llvm \ - gcovr - - - name: Configure repository - shell: bash - run: ./configure.sh - - - name: Configure ccache - uses: hendrikmuhs/ccache-action@v1.2 - with: - key: ${{ github.workflow }}-coverage - - - name: CMake - shell: bash - env: - CC: clang-18 - CXX: clang++-18 - CMAKE_C_COMPILER_LAUNCHER: ccache - CMAKE_CXX_COMPILER_LAUNCHER: ccache - # -g1 should slightly reduce build time. - run: | - cmake . -B build -G Ninja -DCMAKE_BUILD_TYPE=Debug \ - -DCMAKE_CXX_FLAGS=-g1 -DCOVERAGE_REPORT=ON - - - name: Compile - shell: bash - working-directory: build - run: ninja - - - name: Tests - shell: bash - working-directory: build - env: - QT_QPA_PLATFORM: "offscreen" - # generator_integration_tests - https://github.com/organicmaps/organicmaps/issues/225 - # opening_hours_integration_tests - https://github.com/organicmaps/organicmaps/issues/219 - # opening_hours_supported_features_tests - https://github.com/organicmaps/organicmaps/issues/219 - # routing_integration_tests - https://github.com/organicmaps/organicmaps/issues/221 - # shaders_tests - https://github.com/organicmaps/organicmaps/issues/223 - # world_feed_integration_tests - https://github.com/organicmaps/organicmaps/issues/215 - CTEST_EXCLUDE_REGEX: "generator_integration_tests|opening_hours_integration_tests|opening_hours_supported_features_tests|routing_benchmarks|routing_integration_tests|routing_quality_tests|search_quality_tests|storage_integration_tests|shaders_tests|world_feed_integration_tests" - run: | - sudo locale-gen en_US - sudo locale-gen en_US.UTF-8 - sudo locale-gen es_ES - sudo locale-gen es_ES.UTF-8 - sudo locale-gen fr_FR - sudo locale-gen fr_FR.UTF-8 - sudo locale-gen ru_RU - sudo locale-gen ru_RU.UTF-8 - sudo update-locale - ctest -L "omim-test" -E "$CTEST_EXCLUDE_REGEX" --output-on-failure - - - name: Run coverage report generation - shell: bash - working-directory: build - run: | - cmake --build . --target omim_coverage - cat coverage_report/summary.txt - - - name: Archive the coverage report - working-directory: build/coverage_report - run: zip -r coverage_report.zip html/ - - - name: Upload artifact - uses: actions/upload-artifact@v4 - with: - name: coverage-report - path: build/coverage_report/coverage_report.zip diff --git a/.github/workflows/linux-check.yaml b/.github/workflows/linux-check.yaml deleted file mode 100644 index 17adeecbd2..0000000000 --- a/.github/workflows/linux-check.yaml +++ /dev/null @@ -1,186 +0,0 @@ -name: Linux Check -on: - workflow_dispatch: # Manual trigger - push: - branches: - - master - pull_request: - paths-ignore: - - .gitignore - - .github/** - - '!.github/workflows/linux-check.yaml' # Run check on self change - - CONTRIBUTORS - - LICENSE - - NOTICE - - README.md - - android/** - - iphone/** - - data/strings/** - - docs/** - - packaging/** - - platform/*apple* - - platform/*_android* - - platform/*_ios* - - platform/*_mac* - - platform/*_win* - - pyhelpers/** - - tools/** - - '!tools/python/test_server/**' - - xcode/** - -jobs: - linux-no-unity: - name: Linux no unity build - runs-on: ubuntu-24.04 - # Cancels previous jobs if the same branch or PR was updated again. - concurrency: - group: ${{ github.workflow }}-no-unity-${{ github.event.pull_request.number || github.ref }} - cancel-in-progress: true - - steps: - - name: Free disk space by removing .NET, Android and Haskell - shell: bash - run: | - sudo rm -rf /usr/share/dotnet /usr/local/lib/android /opt/ghc - - - name: Checkout sources - uses: actions/checkout@v4 - with: - fetch-depth: 100 # enough to get all commits for the current day - - - name: Parallel submodules checkout - shell: bash - run: git submodule update --depth 1 --init --recursive --jobs=$(($(nproc) * 20)) - - - name: Install build tools and dependencies - shell: bash - run: | - sudo apt update -y - sudo apt install -y \ - ninja-build \ - libgl1-mesa-dev \ - libglvnd-dev \ - libharfbuzz-dev \ - qt6-base-dev \ - libqt6svg6-dev \ - qt6-positioning-dev \ - libqt6positioning6-plugins \ - libqt6positioning6 - - - name: Configure repository - shell: bash - run: ./configure.sh - - - name: Configure ccache - uses: hendrikmuhs/ccache-action@v1.2 - with: - key: ${{ github.workflow }}-no-unity - - - name: CMake - shell: bash - env: - CC: clang-18 - CXX: clang++-18 - CMAKE_C_COMPILER_LAUNCHER: ccache - CMAKE_CXX_COMPILER_LAUNCHER: ccache - # -g1 should slightly reduce build time. - run: | - cmake . -B build -G Ninja -DCMAKE_BUILD_TYPE=Debug \ - -DCMAKE_CXX_FLAGS=-g1 -DUNITY_DISABLE=ON - - - name: Compile - shell: bash - working-directory: build - run: ninja - - linux-matrix: - name: Linux builds and tests - runs-on: ubuntu-24.04 - strategy: - fail-fast: false - matrix: - compiler: [{ CXX: g++-14, CC: gcc-14 }, { CXX: clang++-18, CC: clang-18 }] - CMAKE_BUILD_TYPE: [Debug, RelWithDebInfo] - # Cancels previous jobs if the same branch or PR was updated again. - concurrency: - group: ${{ github.workflow }}-unity-${{ matrix.compiler.CC }}-${{ matrix.CMAKE_BUILD_TYPE }}-${{ github.event.pull_request.number || github.ref }} - cancel-in-progress: true - - steps: - - name: Free disk space by removing .NET, Android and Haskell - shell: bash - run: | - sudo rm -rf /usr/share/dotnet /usr/local/lib/android /opt/ghc - - - name: Checkout sources - uses: actions/checkout@v4 - - - name: Parallel submodules checkout - shell: bash - run: git submodule update --depth 1 --init --recursive --jobs=$(($(nproc) * 20)) - - - name: Install build tools and dependencies - shell: bash - run: | - sudo apt update -y - sudo apt install -y \ - ninja-build \ - libgl1-mesa-dev \ - libglvnd-dev \ - libharfbuzz-dev \ - qt6-base-dev \ - libqt6svg6-dev \ - qt6-positioning-dev \ - libqt6positioning6-plugins \ - libqt6positioning6 - - - name: Configure repository - shell: bash - run: ./configure.sh - - - name: Configure ccache - uses: hendrikmuhs/ccache-action@v1.2 - with: - key: ${{ github.workflow }}-unity-${{ matrix.compiler.CC }}-${{ matrix.CMAKE_BUILD_TYPE }} - - - name: CMake - shell: bash - env: - CC: ${{ matrix.compiler.CC }} - CXX: ${{ matrix.compiler.CXX }} - CMAKE_C_COMPILER_LAUNCHER: ccache - CMAKE_CXX_COMPILER_LAUNCHER: ccache - # -g1 should slightly reduce build time. - run: | - echo "Building ${{ matrix.CMAKE_BUILD_TYPE }}" - cmake . -B build -G Ninja -DCMAKE_BUILD_TYPE=${{ matrix.CMAKE_BUILD_TYPE }} \ - -DCMAKE_C_FLAGS=-g1 -DCMAKE_CXX_FLAGS=-g1 - - - name: Compile - shell: bash - working-directory: build - run: ninja - - - name: Tests - shell: bash - working-directory: build - env: - QT_QPA_PLATFORM: "offscreen" - # generator_integration_tests - https://github.com/organicmaps/organicmaps/issues/225 - # opening_hours_integration_tests - https://github.com/organicmaps/organicmaps/issues/219 - # opening_hours_supported_features_tests - https://github.com/organicmaps/organicmaps/issues/219 - # routing_integration_tests - https://github.com/organicmaps/organicmaps/issues/221 - # shaders_tests - https://github.com/organicmaps/organicmaps/issues/223 - # world_feed_integration_tests - https://github.com/organicmaps/organicmaps/issues/215 - CTEST_EXCLUDE_REGEX: "generator_integration_tests|opening_hours_integration_tests|opening_hours_supported_features_tests|routing_benchmarks|routing_integration_tests|routing_quality_tests|search_quality_tests|storage_integration_tests|shaders_tests|world_feed_integration_tests" - run: | - sudo locale-gen en_US - sudo locale-gen en_US.UTF-8 - sudo locale-gen es_ES - sudo locale-gen es_ES.UTF-8 - sudo locale-gen fr_FR - sudo locale-gen fr_FR.UTF-8 - sudo locale-gen ru_RU - sudo locale-gen ru_RU.UTF-8 - sudo update-locale - ctest -L "omim-test" -E "$CTEST_EXCLUDE_REGEX" --output-on-failure diff --git a/.github/workflows/macos-check.yaml b/.github/workflows/macos-check.yaml deleted file mode 100644 index 3d6c5232e0..0000000000 --- a/.github/workflows/macos-check.yaml +++ /dev/null @@ -1,97 +0,0 @@ -name: macOS Check -on: - workflow_dispatch: # Manual trigger - push: - branches: - - master - pull_request: - paths-ignore: - - .gitignore - - .github/** - - '!.github/workflows/macos-check.yaml' # Run check on self change - - CONTRIBUTORS - - LICENSE - - NOTICE - - README.md - - android/** - - iphone/** - - data/strings/** - - docs/** - - packaging/** - - platform/*_android* - - platform/*_ios* - - platform/*_linux* - - platform/*_win* - - pyhelpers/** - - tools/** - - '!tools/python/test_server/**' - - xcode/** - -jobs: - macos-matrix: - name: macOS builds and tests - runs-on: macos-15 - env: - DEVELOPER_DIR: /Applications/Xcode_16.app/Contents/Developer - HOMEBREW_NO_ANALYTICS: 1 - HOMEBREW_NO_INSTALL_CLEANUP: 1 - strategy: - fail-fast: false - matrix: - CMAKE_BUILD_TYPE: [Debug, RelWithDebInfo] - # Cancels previous jobs if the same branch or PR was updated again. - concurrency: - group: ${{ github.workflow }}-${{ matrix.CMAKE_BUILD_TYPE }}-${{ github.event.pull_request.number || github.ref }} - cancel-in-progress: true - - steps: - - name: Checkout sources - uses: actions/checkout@v4 - - - name: Parallel submodules checkout - shell: bash - run: git submodule update --depth 1 --init --recursive --jobs=$(($(sysctl -n hw.logicalcpu) * 20)) - - - name: Install build tools and dependencies - shell: bash - run: | - HOMEBREW_NO_INSTALLED_DEPENDENTS_CHECK=1 brew install ninja qt@6 - - - name: Configure repository - shell: bash - run: ./configure.sh - - - name: Configure ccache - uses: hendrikmuhs/ccache-action@v1.2 - with: - key: ${{ github.workflow }}-${{ matrix.CMAKE_BUILD_TYPE }} - - - name: CMake - shell: bash - env: - CMAKE_C_COMPILER_LAUNCHER: ccache - CMAKE_CXX_COMPILER_LAUNCHER: ccache - run: | - echo "Building ${{ matrix.CMAKE_BUILD_TYPE }}" - cmake . -B build -G Ninja -DCMAKE_BUILD_TYPE=${{ matrix.CMAKE_BUILD_TYPE }} \ - -DCMAKE_C_FLAGS=-g1 -DCMAKE_CXX_FLAGS=-g1 - - - name: Compile - shell: bash - working-directory: build - run: ninja - - - name: Tests - shell: bash - working-directory: build - env: - # drape_tests - requires X Window - # generator_integration_tests - https://github.com/organicmaps/organicmaps/issues/225 - # opening_hours_integration_tests - https://github.com/organicmaps/organicmaps/issues/219 - # opening_hours_supported_features_tests - https://github.com/organicmaps/organicmaps/issues/219 - # routing_integration_tests - https://github.com/organicmaps/organicmaps/issues/221 - # shaders_tests - https://github.com/organicmaps/organicmaps/issues/223 - # world_feed_integration_tests - https://github.com/organicmaps/organicmaps/issues/215 - CTEST_EXCLUDE_REGEX: "drape_tests|generator_integration_tests|opening_hours_integration_tests|opening_hours_supported_features_tests|routing_benchmarks|routing_integration_tests|routing_quality_tests|search_quality_tests|storage_integration_tests|shaders_tests|world_feed_integration_tests" - run: | - ctest -L "omim-test" -E "$CTEST_EXCLUDE_REGEX" --output-on-failure