Upgrading Github Action runners to ubuntu24.04

.github/workflows/build-nightly-release.yaml

@@ -15,7 +15,7 @@ on:
 jobs:
   setup:
     name: Setup the release
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
     - name: Checkout Catalyst repo
       uses: actions/checkout@v4
@@ -56,7 +56,7 @@ jobs:
     name: Prepare & Upload wheels to TestPyPI
     if: ${{ !failure() && !cancelled() }}  # needed in case linux-aarch is skipped
     needs: [linux-x86, macos-arm, linux-aarch]
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     permissions:
       id-token: write  # IMPORTANT: mandatory for trusted publishing
 

.github/workflows/build-wheel-linux-arm64.yaml

@@ -61,7 +61,7 @@ jobs:
         container_img: ["manylinux_2_28_aarch64"]
 
     name: Build Dependencies (Python ${{ matrix.python_version }})
-    runs-on: ubuntu-22.04-arm
+    runs-on: ubuntu-24.04-arm
     container: quay.io/pypa/${{ matrix.container_img }}
 
     if: needs.check_if_wheel_build_required.outputs.build-wheels == 'true'
@@ -241,7 +241,7 @@ jobs:
         container_img: ["manylinux_2_28_aarch64"]
 
     name: Build Wheels (Python ${{ matrix.python_version }})
-    runs-on: ubuntu-22.04-arm
+    runs-on: ubuntu-24.04-arm
     container: quay.io/pypa/${{ matrix.container_img }}
 
     steps:
@@ -405,7 +405,7 @@ jobs:
 
     # To check all wheels for supported python3 versions
     name: Test Wheels (Python ${{ matrix.python_version }}) on Linux Arm
-    runs-on: ubuntu-22.04-arm
+    runs-on: ubuntu-24.04-arm
 
     steps:
     - name: Checkout Catalyst repo

.github/workflows/build-wheel-linux-x86_64.yaml

@@ -47,7 +47,7 @@ jobs:
     name: Determine runner type to use
     uses: ./.github/workflows/determine-workflow-runner.yml
     with:
-      default_runner: ubuntu-22.04
+      default_runner: ubuntu-24.04
 
   check_if_wheel_build_required:
     if: github.event.pull_request.draft == false

.github/workflows/changelog-reminder.yaml

@@ -9,7 +9,7 @@ name: Changelog Reminder
 jobs:
   remind:
     name: Changelog Reminder
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
     - uses: actions/checkout@master
     - name: Changelog Reminder

.github/workflows/check-catalyst.yaml

@@ -21,7 +21,7 @@ jobs:
     name: Determine runner type to use
     uses: ./.github/workflows/determine-workflow-runner.yml
     with:
-      default_runner: ubuntu-22.04
+      default_runner: ubuntu-24.04
 
   constants:
     name: "Set build matrix"
@@ -48,6 +48,17 @@ jobs:
           sudo apt-get update
           sudo apt-get -y -q install ninja-build make cmake clang libomp-dev
           python3 -m pip install nanobind pybind11
+          sudo apt-get remove -y gcc g++
+          sudo apt-get install -y gcc-11 g++-11
+          sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-11 10
+          sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-11 10          
+
+      - name: Which gcc
+        run: |        
+          gcc --version
+          g++ --version
+          which gcc
+          which g++
 
       - name: Get Cached LLVM Source
         id: cache-llvm-source
@@ -68,17 +79,17 @@ jobs:
       - name: Build Catalyst-Runtime
         run: |
           COMPILER_LAUNCHER="" \
-          C_COMPILER=$(which ${{ needs.constants.outputs[format('c_compiler.{0}', matrix.compiler)] }}) \
-          CXX_COMPILER=$(which ${{ needs.constants.outputs[format('cxx_compiler.{0}', matrix.compiler)] }}) \
+          C_COMPILER=$(which ${{ needs.constants.outputs[format('c_compiler_gcc', matrix.compiler)] }}) \
+          CXX_COMPILER=$(which ${{ needs.constants.outputs[format('cxx_compiler_gxx', matrix.compiler)] }}) \
           RT_BUILD_DIR="$(pwd)/runtime-build" \
           LLVM_DIR="$(pwd)/mlir/llvm-project" \
           ENABLE_ASAN=OFF \
           ENABLE_OQD=ON \
           make runtime
 
           COMPILER_LAUNCHER="" \
-          C_COMPILER=$(which ${{ needs.constants.outputs[format('c_compiler.{0}', matrix.compiler)] }}) \
-          CXX_COMPILER=$(which ${{ needs.constants.outputs[format('cxx_compiler.{0}', matrix.compiler)] }}) \
+          C_COMPILER=$(which ${{ needs.constants.outputs[format('c_compiler_gcc', matrix.compiler)] }}) \
+          CXX_COMPILER=$(which ${{ needs.constants.outputs[format('cxx_compiler_gxx', matrix.compiler)] }}) \
           RT_BUILD_DIR="$(pwd)/runtime-build" \
           OQC_BUILD_DIR="$(pwd)/oqc-build" \
           LLVM_DIR="$(pwd)/mlir/llvm-project" \
@@ -141,22 +152,22 @@ jobs:
         key: ${{ runner.os }}-llvm-${{ needs.constants.outputs.llvm_version }}-ci-build-${{ matrix.compiler }}
 
     - name: Install Deps
-      if: steps.cache-llvm-build.outputs.cache-hit != 'true'
+      # if: steps.cache-llvm-build.outputs.cache-hit != 'true'
       run: |
         sudo apt-get update
         sudo apt-get install -y python3 python3-pip cmake ninja-build clang lld
-        python3 --version | grep ${{ needs.constants.outputs.primary_python_version }}
+        # python3 --version | grep ${{ needs.constants.outputs.primary_python_version }}
         python3 -m pip install numpy pybind11
 
     - name: Build LLVM
-      if: steps.cache-llvm-build.outputs.cache-hit != 'true'
+      # if: steps.cache-llvm-build.outputs.cache-hit != 'true'
       # Note: Disable instrumentation for the mlir runtime support library,
       #       as user programs aren't instrumented.
       run: |
         # echo 'target_compile_options(mlir_c_runner_utils PRIVATE "-fno-sanitize=all")' \
         #       >> mlir/llvm-project/mlir/lib/ExecutionEngine/CMakeLists.txt
-        C_COMPILER=$(which ${{ needs.constants.outputs[format('c_compiler.{0}', matrix.compiler)] }}) \
-        CXX_COMPILER=$(which ${{ needs.constants.outputs[format('cxx_compiler.{0}', matrix.compiler)] }}) \
+        C_COMPILER=$(which ${{ needs.constants.outputs[format('c_compiler_gcc', matrix.compiler)] }}) \
+        CXX_COMPILER=$(which ${{ needs.constants.outputs[format('cxx_compiler_gxx', matrix.compiler)] }}) \
         LLVM_BUILD_DIR="$(pwd)/llvm-build" \
         COMPILER_LAUNCHER="" \
         make llvm
@@ -224,8 +235,8 @@ jobs:
     - name: Build MHLO Dialect
       if: steps.cache-mhlo.outputs.cache-hit != 'true'
       run: |
-        C_COMPILER=$(which ${{ needs.constants.outputs[format('c_compiler.{0}', matrix.compiler)] }}) \
-        CXX_COMPILER=$(which ${{ needs.constants.outputs[format('cxx_compiler.{0}', matrix.compiler)] }}) \
+        C_COMPILER=$(which ${{ needs.constants.outputs[format('c_compiler_gcc', matrix.compiler)] }}) \
+        CXX_COMPILER=$(which ${{ needs.constants.outputs[format('cxx_compiler_gxx', matrix.compiler)] }}) \
         LLVM_BUILD_DIR="$(pwd)/llvm-build" \
         MHLO_BUILD_DIR="$(pwd)/mhlo-build" \
         COMPILER_LAUNCHER="" \
@@ -294,8 +305,8 @@ jobs:
     - name: Build Enzyme
       if: steps.cache-enzyme-build.outputs.cache-hit != 'true'
       run: |
-        C_COMPILER=$(which ${{ needs.constants.outputs[format('c_compiler.{0}', matrix.compiler)] }}) \
-        CXX_COMPILER=$(which ${{ needs.constants.outputs[format('cxx_compiler.{0}', matrix.compiler)] }}) \
+        C_COMPILER=$(which ${{ needs.constants.outputs[format('c_compiler_gcc', matrix.compiler)] }}) \
+        CXX_COMPILER=$(which ${{ needs.constants.outputs[format('cxx_compiler_gxx', matrix.compiler)] }}) \
         LLVM_BUILD_DIR="$(pwd)/llvm-build" \
         ENZYME_BUILD_DIR="$(pwd)/enzyme-build" \
         COMPILER_LAUNCHER="" \
@@ -305,6 +316,8 @@ jobs:
     name: Quantum Dialects Build
     needs: [constants, llvm, mhlo, enzyme, determine_runner]
     runs-on: ${{ needs.determine_runner.outputs.runner_group }}
+    env:
+      ACTIONS_STEP_DEBUG: true
     strategy:
       matrix:
         compiler: ${{ fromJson(needs.constants.outputs.compilers) }}
@@ -383,8 +396,8 @@ jobs:
     - name: Build MLIR Dialects
       run: |
         CCACHE_DIR="$(pwd)/.ccache" \
-        C_COMPILER=$(which ${{ needs.constants.outputs[format('c_compiler.{0}', matrix.compiler)] }}) \
-        CXX_COMPILER=$(which ${{ needs.constants.outputs[format('cxx_compiler.{0}', matrix.compiler)] }}) \
+        C_COMPILER=$(which ${{ needs.constants.outputs[format('c_compiler_gcc', matrix.compiler)] }}) \
+        CXX_COMPILER=$(which ${{ needs.constants.outputs[format('cxx_compiler_gxx', matrix.compiler)] }}) \
         LLVM_BUILD_DIR="$(pwd)/llvm-build" \
         MHLO_BUILD_DIR="$(pwd)/mhlo-build" \
         ENZYME_BUILD_DIR="$(pwd)/enzyme-build" \
@@ -394,8 +407,8 @@ jobs:
     - name: Build Standalone Plugin
       run: |
         CCACHE_DIR="$(pwd)/.ccache" \
-        C_COMPILER=$(which ${{ needs.constants.outputs[format('c_compiler.{0}', matrix.compiler)] }}) \
-        CXX_COMPILER=$(which ${{ needs.constants.outputs[format('cxx_compiler.{0}', matrix.compiler)] }}) \
+        C_COMPILER=$(which ${{ needs.constants.outputs[format('c_compiler_gcc', matrix.compiler)] }}) \
+        CXX_COMPILER=$(which ${{ needs.constants.outputs[format('cxx_compiler_gxx', matrix.compiler)] }}) \
         LLVM_BUILD_DIR="$(pwd)/llvm-build" \
         MLIR_DIR="$(pwd)/llvm-build/lib/cmake/mlir" \
         make plugin
@@ -635,8 +648,8 @@ jobs:
 
       - name: Build Runtime test suite for OQC device
         run: |
-          C_COMPILER=$(which ${{ needs.constants.outputs[format('c_compiler.{0}', matrix.compiler)] }}) \
-          CXX_COMPILER=$(which ${{ needs.constants.outputs[format('cxx_compiler.{0}', matrix.compiler)] }}) \
+          C_COMPILER=$(which ${{ needs.constants.outputs[format('c_compiler_gcc', matrix.compiler)] }}) \
+          CXX_COMPILER=$(which ${{ needs.constants.outputs[format('cxx_compiler_gxx', matrix.compiler)] }}) \
           RT_BUILD_DIR="$(pwd)/runtime-build" \
           make test-oqc
 
@@ -654,6 +667,10 @@ jobs:
           sudo apt-get update
           sudo apt-get -y -q install cmake ninja-build lcov
           python3 -m pip install nanobind pybind11
+          sudo apt-get remove -y gcc g++
+          sudo apt-get install -y gcc-11 g++-11
+          sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-11 10
+          sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-11 10  
 
       - name: Install additional dependencies for OpenQasm device
         run: |
@@ -675,11 +692,16 @@ jobs:
           repository: llvm/llvm-project
           ref: ${{ needs.constants.outputs.llvm_version }}
           path: mlir/llvm-project
+
+      - name: Which gcc
+        run: |        
+          gcc --version
+          g++ --version
 
       - name: Run the main runtime test suite for coverage
         run: |
-          C_COMPILER=$(which gcc) \
-          CXX_COMPILER=$(which g++) \
+          C_COMPILER="/usr/bin/gcc-11" \
+          CXX_COMPILER=/usr/bin/g++-11 \
           COMPILER_LAUNCHER="" \
           ENABLE_OQD=ON \
           LLVM_DIR="$(pwd)/mlir/llvm-project" \

.github/workflows/check-for-wheel-build.yml

@@ -9,42 +9,42 @@
 
 jobs:
   check_if_required:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
 
     steps:
       - name: Build is triggered from Pull Request
         id: is_pr
         run: echo "is_pr=${{ github.event_name == 'pull_request' }}" >> $GITHUB_OUTPUT
 
       - name: Pull Request Build needs Wheel Builds to pass
         id: needs_wheel_builds
         if: steps.is_pr.outputs.is_pr == 'true'
         run: echo "needs_wheel_builds=${{ contains(github.event.pull_request.labels.*.name, 'reviewer:require-wheels') }}" >> $GITHUB_OUTPUT
 
       # If the trigger for this workflow (on pull_request) is a labelling event, then only build the wheels if the
       # label being added is `author:build-wheels`. If the pull_request event is not a labelling event (eg: new commit is pushed)
       # then build wheels as long as the `author:build-wheels` label is present
       - name: Build Wheels for Pull Request
         id: build_wheels
         if: steps.is_pr.outputs.is_pr == 'true'
         run: |
           echo "build_wheels=${{
            (github.event.action != 'labeled' && contains(github.event.pull_request.labels.*.name, 'author:build-wheels')) ||
            github.event.label.name == 'author:build-wheels'
           }}" >> $GITHUB_OUTPUT
 
       # If a pr has the `reviewer:require-wheels` label, that means that the Workflows which build wheels need to successfully run against it
       # However, the PR does not have the `author:build-wheels` label, meaning it is not ready for the wheel workflows to run against it yet.
       # In that condition, this step will fail, causing the entire workflow to fail.
       # And since this job is required to pass on all jobs, it will cause the merging of the pull request to be blocked.
       - name: Fail for Pull Request that needs wheels built but does not have build-wheels label
         if: steps.is_pr.outputs.is_pr == 'true' && steps.needs_wheel_builds.outputs.needs_wheel_builds == 'true' && steps.build_wheels.outputs.build_wheels == 'false'
         run: |
           echo ::error title=Failing for Pull Request that needs wheel builds with build-wheels label missing::This pull request requires the wheels to build successfully against it. Add the `author:build-wheels` label. && exit 1
 
     outputs:
       build-wheels: >-
         ${{
           steps.is_pr.outputs.is_pr == 'false' ||
           steps.build_wheels.outputs.build_wheels == 'true'
         }}

.github/workflows/check-formatting.yaml

@@ -11,7 +11,7 @@ concurrency:
 jobs:
   format-python:
     name: Python Formatting & Linting
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
 
     steps:
       - name: Install dependencies
@@ -31,7 +31,7 @@ jobs:
 
   format-cpp:
     name: C++ Formatting
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
 
     steps:
       - name: Checkout code

.github/workflows/check-jax-release.yaml

@@ -12,7 +12,7 @@ concurrency:
 jobs:
   check-jax:
     name: Build/Test Catalyst against JAX
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     strategy:
       fail-fast: false
       matrix:

.github/workflows/check-pl-compat.yaml

@@ -27,7 +27,7 @@ jobs:
   check-config:
     name: Build Configuration
     needs: [constants]
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
 
     steps:
     - name: Checkout Catalyst repo

.github/workflows/constants.yaml

@@ -37,13 +37,13 @@ on:
       compilers:
         description: "List of compilers to test Catalyst builds with."
         value: ${{ jobs.set-constants.outputs.compilers }}
-      c_compiler.gcc:
+      c_compiler_gcc:
         value: gcc
-      c_compiler.clang:
+      c_compiler_clang:
         value: clang
-      cxx_compiler.gcc:
+      cxx_compiler_gxx:
         value: g++
-      cxx_compiler.clang:
+      cxx_compiler_clang:
         value: clang++
 
 jobs:

.github/workflows/determine-workflow-runner.yml

@@ -22,7 +22,7 @@ jobs:
         (
           github.event_name == 'pull_request'
           && contains(github.event.pull_request.labels.*.name, 'urgent')
-        ) && 'pl-4-core-large-runner' || 'ubuntu-22.04'
+        ) && 'pl-4-core-large-runner' || 'ubuntu-24.04'
       }}
 
     outputs:

.github/workflows/notify-failed-jobs.yaml

@@ -13,14 +13,14 @@
 
 jobs:
   on-failure:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     if: github.event.workflow_run.conclusion == 'failure' || github.event.workflow_run.conclusion == 'timed_out'
     steps:
       - uses: ravsamhq/notify-slack-action@v2
         with:
           status: ${{ github.event.workflow_run.conclusion }}
           notification_title: " ${{github.event.workflow_run.name}} - ${{github.event.workflow_run.conclusion}} on ${{github.event.workflow_run.head_branch}} - <${{github.server_url}}/${{github.repository}}/actions/runs/${{github.event.workflow_run.id}}|View Failure>"
           message_format: ":fire: *${{github.event.workflow_run.name}}* ${{github.event.workflow_run.conclusion}} in <${{github.server_url}}/${{github.repository}}/tree/${{github.event.workflow_run.head_branch}}|${{github.repository}}>"
           footer: "Linked Repo <${{github.server_url}}/${{github.repository}}|${{github.repository}}> | <${{github.server_url}}/${{github.repository}}/actions/runs/${{github.event.workflow_run.id}}|View Failure>"
         env:
           SLACK_WEBHOOK_URL: ${{ secrets.SLACK_NOTIFICATIONS_WEBHOOK_URL }}

.github/workflows/rc_sync.yaml

@@ -19,67 +19,67 @@
   # This workflow contains a single job to sync the main branch with changes from the rc
   sync:
     # The type of runner that the job will run on
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
 
       # Checks-out the Catalyst repository
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       # Import Numpy/Pybind11 because it is imported in setup.py
       - name: Install Numpy and Pybind11
         run: |
           python -m pip install --upgrade pip
           pip install numpy pybind11
 
       # Check for the existence of an rc branch for the current Catalyst version
       - name: Check for rc branch
         run: |
           VERSION=$(python setup.py --version)
           IFS=. read MAJ MIN PAT <<< "${VERSION%.dev[0-9]*}"
           RC_BRANCH="v${MAJ}.$((MIN-1)).${PAT}-rc"
           if git ls-remote --exit-code origin "refs/heads/$RC_BRANCH"; then
             echo "branch_exists=true" >> $GITHUB_ENV
             echo "rc_branch=$RC_BRANCH" >> $GITHUB_ENV
           else
             echo "branch_exists=false" >> $GITHUB_ENV
           fi
           echo "new_changes=false" >> $GITHUB_ENV
 
       # Create a new branch at from the current rc to be used in the PR
       - name: Create temp branch
         if: ${{ env.branch_exists == 'true' }}
         run: |
           git fetch
           git checkout "${{ env.rc_branch }}"
           BRANCH="rc_$(date +'%Y-%m-%d-%H-%M-%S')"
           echo "tmp_branch=$BRANCH" >> $GITHUB_ENV
           git checkout -b "$BRANCH"
           # Exclude some files known to be divergent during the release process from the PR
           git checkout origin/main -- frontend/catalyst/_version.py
           git checkout origin/main -- doc/dev/release_notes.rst
           git config user.name "GitHub Actions Bot"
           git config user.email "<>"
           git commit -m "exclude files from pr"
           # check for new changes on the rc branch only, based on the diff between main and rc
           if ! git diff origin/main HEAD --quiet -- $(git diff --name-only origin/main...HEAD); then
             echo "new_changes=true" >> $GITHUB_ENV
             git push --set-upstream origin "$BRANCH"
           fi
 
       # Create PR to main
       - name: Create pull request
         if: ${{ env.new_changes == 'true' }}
         uses: repo-sync/pull-request@v2
         with:
           source_branch: "${{ env.tmp_branch }}"
           destination_branch: "main"
           github_token: "${{ secrets.GITHUB_TOKEN }}"
           pr_title: "Daily rc sync to main"
           pr_body: "Automatic sync from the release candidate to main during a feature freeze."
           pr_allow_empty: false
           pr_draft: false
           pr_reviewer: "dime10,mehrdad2m"

.readthedocs.yaml

@@ -17,7 +17,7 @@ formats:
 
 # Optionally set the build image
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
       python: "3.10"
   apt_packages:

mlir/cmake/modules/CatalystConfig.cmake.in

@@ -12,6 +12,9 @@
 
 # MLIR is needed for this setup to be usable.
 find_package(MLIR REQUIRED CONFIG)
+find_package(Python3 COMPONENTS Interpreter Development)
+find_package(Python3 COMPONENTS Interpreter Development.Module REQUIRED)
+find_package(Python3 REQUIRED COMPONENTS Development NumPy)
 
 # Set variables needed by dependent projects.
 set(CATALYST_BUILD_LIBRARY_DIR "@CATALYST_LIB_DIR@")