builds.yml

name: Builds

on:
  push:
  pull_request:
    branches:
      - main
      - 'release/**'
      - 'develop/**'
    paths-ignore:
      - "docs/**"

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

env:
  CTEST_OUTPUT_ON_FAILURE: 1
  HOMEBREW_NO_INSTALL_CLEANUP: 1
  CCACHE_DIR: ${{ github.workspace }}/ccache
  CCACHE_MAXSIZE: 500M
  CCACHE_KEY_SUFFIX: r1

jobs:
  linux_ubuntu:
    runs-on: ubuntu-latest
    container: ghcr.io/acts-project/ubuntu2404:58
    env:
      INSTALL_DIR: ${{ github.workspace }}/install
      ACTS_LOG_FAILURE_THRESHOLD: WARNING
    steps:
      - name: Install git lfs
        run: apt-get update && apt-get install -y git-lfs

      - uses: actions/checkout@v4
        with:
          submodules: true
          lfs: true

      - name: Restore ccache
        uses: actions/cache/restore@v4
        id: ccache-restore
        with:
          path: ${{ github.workspace }}/ccache
          key: ${{ runner.os  }}-ccache-linux_ubuntu_${{ env.CCACHE_KEY_SUFFIX }}_${{ github.sha }}
          restore-keys: |
            ${{ runner.os  }}-ccache-linux_ubuntu_${{ env.CCACHE_KEY_SUFFIX }}_

      - name: Configure
        # setting CMAKE_CXX_STANDARD=20 is a workaround for a bug in the
        # dd4hep CMake configuration that gets triggered on recent CMake
        # versions
        # Need to set git user & email for patching to work (GeoModel plugin)
        run: >
          git config --global user.name 'CI' &&
          git config --global user.email '<>' &&
          ccache -z &&
          cmake -B build -S .
          --preset=github-ci
          -DCMAKE_INSTALL_PREFIX="${INSTALL_DIR}"
          -DACTS_BUILD_PLUGIN_ONNX=ON

      - name: Build
        run: cmake --build build

      - name: ccache stats
        run: ccache -s

      - name: Save ccache
        uses: actions/cache/save@v4
        if: always()
        with:
          path: ${{ github.workspace }}/ccache
          key: ${{ steps.ccache-restore.outputs.cache-primary-key }}

      - name: Unit tests
        run: ctest --test-dir build -j$(nproc)

      - name: Integration tests
        run: cmake --build build --target integrationtests

      - name: Install
        run: cmake --build build --target install


      - name: Package build
        run: tar czf build.tar.gz -C build --exclude "*.o" --exclude "bin/ActsUnitTest*" --exclude "bin/ActsIntegrationTest*" .

      - uses: actions/upload-artifact@v4
        with:
          name: acts-linux-ubuntu
          path: build.tar.gz

      - name: Downstream configure
        run: >
          cmake -B build-downstream -S Tests/DownstreamProject
          -GNinja
          -DCMAKE_BUILD_TYPE=Release
          -DCMAKE_CXX_FLAGS=-Werror
          -DCMAKE_CXX_STANDARD=20
          -DCMAKE_PREFIX_PATH="${INSTALL_DIR}"

      - name: Downstream build
        run: cmake --build build-downstream

      - name: Downstream run
        run: ./build-downstream/bin/ShowActsVersion

  linux_examples_test:
    runs-on: ubuntu-latest
    container: ghcr.io/acts-project/ubuntu2404:58
    needs: [linux_ubuntu]
    env:
      ACTS_SEQUENCER_DISABLE_FPEMON: true

    steps:
      - name: Install git lfs
        run: apt-get update && apt-get install -y git-lfs

      - uses: actions/checkout@v4
        with:
          submodules: true
          lfs: true

      - uses: actions/download-artifact@v4
        with:
          name: acts-linux-ubuntu

      - name: Unpack build
        run: mkdir build && tar xf build.tar.gz -C build

      - name: Python level tests
        shell: bash
        env:
          PYTEST_MD_REPORT: true
          PYTEST_MD_REPORT_VERBOSE: 0
          PYTEST_MD_REPORT_OUTPUT: pytest.md
        run: >
          /usr/local/bin/geant4-config --install-datasets
          && source build/this_acts_withdeps.sh
          && pip3 install -r Examples/Python/tests/requirements.txt
          && pip3 install pytest-md-report
          && pytest -rFsv -k "not exatrkx" -v
          && cat ${PYTEST_MD_REPORT_OUTPUT} >> $GITHUB_STEP_SUMMARY

  linux_physmon:
    runs-on: ubuntu-latest
    container: ghcr.io/acts-project/ubuntu2404:58
    needs: [linux_ubuntu]
    env:
      ACTS_SEQUENCER_DISABLE_FPEMON: true

    steps:
      - name: Install git lfs
        run: apt-get update && apt-get install -y git-lfs time

      - uses: actions/checkout@v4
        with:
          submodules: true
          lfs: true

      - uses: actions/download-artifact@v4
        with:
          name: acts-linux-ubuntu

      - name: Unpack build
        run: mkdir build && tar xf build.tar.gz -C build

      - name: Save PR number
        if: ${{ github.event_name == 'pull_request' }}
        run: |
          mkdir -p physmon
          echo ${{ github.event.number }} > physmon/pr_number
          echo ${{ github.event.pull_request.head.sha }} > physmon/sha

      - name: Physics performance checks
        shell: bash
        run: >
          echo "::group::Dependencies"
          && git config --global safe.directory "$GITHUB_WORKSPACE"
          && pip3 install histcmp==0.6.7 matplotlib
          && pip3 install -r Examples/Scripts/requirements.txt
          && /usr/local/bin/geant4-config --install-datasets
          && source build/this_acts_withdeps.sh
          && echo "::endgroup::"
          && CI/physmon/phys_perf_mon.sh all physmon

      - name: Post step summary
        if: always()
        run: cat physmon/summary.md >> $GITHUB_STEP_SUMMARY

      - uses: actions/upload-artifact@v4
        if: always()
        with:
          name: physmon
          path: physmon

  linux_physmon_perf_report:
    needs: [linux_physmon]
    runs-on: ubuntu-latest
    if: github.ref == 'refs/heads/main'
    steps:
      - name: Install dependencies
        run: pip3 install spyral-cli==1.1.2

      - uses: actions/download-artifact@v4
        with:
          name: physmon
          path: physmon

      - name: Store metrics
        env:
          SSH_AUTH_SOCK: /tmp/ssh_agent.sock
        run: |
          ssh-agent -a $SSH_AUTH_SOCK > /dev/null
          ssh-add - <<< "${{ secrets.RUNTIME_METRIC_DEPLOY_SSH_KEY }}"
          git config --global user.email "action@github.com"
          git config --global user.name "GitHub Action"
          git clone git@github.com:acts-project/runtime_metrics.git
          spyral maxima runtime_metrics/metrics.csv physmon/memory/*.csv -e $(date +%Y-%m-%dT%H-%M-%S) -e ${GITHUB_REF_NAME} -e ${GITHUB_REF} -e ${GITHUB_SHA}
          cd runtime_metrics
          git add -A
          git commit -m"update metrics"
          git push

  linux_ubuntu_extra:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        include:
          - image: ubuntu2204
            std: 20
          - image: ubuntu2204_clang
            std: 20
    container: ghcr.io/acts-project/${{ matrix.image }}:58
    env:
      INSTALL_DIR: ${{ github.workspace }}/install
      ACTS_LOG_FAILURE_THRESHOLD: WARNING
    steps:
      - name: Install git lfs
        run: apt-get update && apt-get install -y git-lfs

      - uses: actions/checkout@v4
        with:
          submodules: true
          lfs: true

      - name: Restore ccache
        uses: actions/cache/restore@v4
        id: ccache-restore
        with:
          path: ${{ github.workspace }}/ccache
          key: ${{ runner.os  }}-ccache-linux_${{ matrix.image }}_${{ env.CCACHE_KEY_SUFFIX }}_${{ github.sha }}
          restore-keys: |
            ${{ runner.os  }}-ccache-linux_${{ matrix.image }}_${{ env.CCACHE_KEY_SUFFIX }}_


      - name: Configure
        # setting CMAKE_CXX_STANDARD=20 is a workaround for a bug in the
        # dd4hep CMake configuration that gets triggered on recent CMake
        # versions
        run: >
          ccache -z &&
          cmake -B build -S .
          --preset=github-ci
          -DCMAKE_CXX_STANDARD=${{ matrix.std }}
          -DCMAKE_INSTALL_PREFIX="${INSTALL_DIR}"

      - name: Build
        run: cmake --build build

      - name: ccache stats
        run: ccache -s

      - name: Save ccache
        uses: actions/cache/save@v4
        if: always()
        with:
          path: ${{ github.workspace }}/ccache
          key: ${{ steps.ccache-restore.outputs.cache-primary-key }}

      - name: Unit tests
        run: cmake --build build --target test

      - name: Integration tests
        run: cmake --build build --target integrationtests

      - name: Install
        run: cmake --build build --target install

      - name: Downstream configure
        run: >
          cmake -B build-downstream -S Tests/DownstreamProject
          -GNinja
          -DCMAKE_BUILD_TYPE=Release
          -DCMAKE_CXX_FLAGS=-Werror
          -DCMAKE_CXX_STANDARD=${{ matrix.std }}
          -DCMAKE_PREFIX_PATH="${INSTALL_DIR}"

      - name: Downstream build
        run: cmake --build build-downstream

      - name: Downstream run
        run: ./build-downstream/bin/ShowActsVersion

  macos:
    runs-on: macos-14
    env:
      INSTALL_DIR: ${{ github.workspace }}/install_acts
      DEPENDENCY_DIR: ${{ github.workspace }}/install
      ACTS_LOG_FAILURE_THRESHOLD: WARNING
      DEPENDENCY_URL: https://acts.web.cern.ch/ACTS/ci/macos-14/deps.v2.tar.zst
      # Works around an issue where root's RPATH is wrong for tbb, thus won't find it
      DYLD_LIBRARY_PATH: "${{ github.workspace }}/install/tbb/2021.11.0/lib"
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: true
          lfs: true

      - name: Print architecture
        run: uname -p

      - name: Install dependencies
        run: >
          brew install cmake ninja ccache xerces-c
          && wget --verbose --progress=dot:giga --continue --retry-connrefused --tries=5 --timeout=2 -O deps.tar.zst ${{ env.DEPENDENCY_URL }}
          && mkdir ${{ env.DEPENDENCY_DIR }}
          && tar -xf deps.tar.zst -C ${{ env.DEPENDENCY_DIR }}
          && PATH="${{ env.DEPENDENCY_DIR }}/bin:$PATH"
          && python3 -m pip install pyyaml jinja2

      - name: Restore ccache
        uses: actions/cache/restore@v4
        id: ccache-restore
        with:
          path: ${{ github.workspace }}/ccache
          key: ${{ runner.os  }}-ccache_${{ env.CCACHE_KEY_SUFFIX }}_${{ github.sha }}
          restore-keys: |
            ${{ runner.os  }}-ccache_${{ env.CCACHE_KEY_SUFFIX }}_

      - name: Configure
        run: >
          ccache -z
          && PATH="${{ env.DEPENDENCY_DIR }}/bin:$PATH"
          && cmake -B build -S .
          --preset=github-ci
          -DCMAKE_PREFIX_PATH="${{ env.DEPENDENCY_DIR }}"
          -DPython_EXECUTABLE=${{ env.DEPENDENCY_DIR }}/bin/python3
          -DCMAKE_INSTALL_PREFIX="${{ env.INSTALL_DIR }}"
      - name: Build
        run: cmake --build build
      - name: ccache stats
        run: ccache -s
      - name: Save ccache
        uses: actions/cache/save@v4
        if: always()
        with:
          path: ${{ github.workspace }}/ccache
          key: ${{ steps.ccache-restore.outputs.cache-primary-key }}
      - name: Unit tests
        run: cmake --build build --target test
      - name: Integration tests
        run: cmake --build build --target integrationtests
      - name: Install
        run: cmake --build build --target install
      - uses: actions/upload-artifact@v4
        with:
          name: acts-macos
          path: ${{ env.INSTALL_DIR }}
      - name: Downstream configure
        run: >
          PATH="${{ env.DEPENDENCY_DIR }}/bin:$PATH"
          && cmake -B build-downstream -S Tests/DownstreamProject
          -GNinja
          -DCMAKE_BUILD_TYPE=Release
          -DCMAKE_CXX_FLAGS=-Werror
          -DCMAKE_CXX_STANDARD=20
          -DCMAKE_PREFIX_PATH="${INSTALL_DIR}"
      - name: Downstream build
        run: cmake --build build-downstream
      - name: Downstream run
        run: >
          PATH="${{ env.DEPENDENCY_DIR }}/bin:$PATH"
          && ./build-downstream/bin/ShowActsVersion