Cherry pick/docs1.28

.github/workflows/build-with-nix.yml

@@ -1,21 +1,26 @@
 name: build with nix
+
 on:
+  pull_request:
+    branches:
+      - main
   schedule:
     # 01:00 every Sunday morning
     - cron: '0 1 * * 0'
   workflow_dispatch: {}
+
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 jobs:
   build_and_test:
     strategy:
       matrix:
-        os: ['ubuntu-22.04', 'macos-14']
+        os: ['ubuntu-24.04', 'macos-14']
     runs-on: ${{matrix.os}}
     steps:
     - uses: actions/checkout@v4
-    - uses: cachix/install-nix-action@v26
+    - uses: cachix/install-nix-action@V27
     - uses: cachix/cachix-action@v14
       with:
         name: tket

.github/workflows/build-without-conan.yml

@@ -9,7 +9,7 @@ concurrency:
   cancel-in-progress: true
 jobs:
   build_and_test:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     env:
       INSTALL_DIR: "/home/runner/local"
       TMP_DIR: "/home/runner/tmp"
@@ -22,17 +22,17 @@ jobs:
     - name: ccache
       uses: hendrikmuhs/ccache-action@v1.2
       with:
-        key: no-conan-build-ubuntu-22.04
+        key: no-conan-build-ubuntu-24.04
     - name: install ninja
       run: |
         sudo apt update
         sudo apt install ninja-build
     - name: Install boost
       run: |
         cd ${TMP_DIR}
-        wget -O boost_1_84_0.tar.gz https://sourceforge.net/projects/boost/files/boost/1.84.0/boost_1_84_0.tar.gz/download
-        tar xzvf boost_1_84_0.tar.gz
-        cd boost_1_84_0/
+        wget -O boost_1_85_0.tar.gz https://sourceforge.net/projects/boost/files/boost/1.85.0/boost_1_85_0.tar.gz/download
+        tar xzvf boost_1_85_0.tar.gz
+        cd boost_1_85_0/
         ./bootstrap.sh --prefix=${INSTALL_DIR}
         ./b2
         ./b2 install
@@ -74,9 +74,9 @@ jobs:
     - name: Install catch2
       run: |
         cd ${TMP_DIR}
-        wget https://github.com/catchorg/Catch2/archive/refs/tags/v3.5.4.tar.gz
-        tar xzvf v3.5.4.tar.gz
-        cd Catch2-3.5.4/
+        wget https://github.com/catchorg/Catch2/archive/refs/tags/v3.6.0.tar.gz
+        tar xzvf v3.6.0.tar.gz
+        cd Catch2-3.6.0/
         mkdir build
         cd build
         cmake -GNinja -DCMAKE_INSTALL_PREFIX=${INSTALL_DIR} ..
@@ -104,9 +104,9 @@ jobs:
     - name: Install pybind11_json
       run: |
         cd ${TMP_DIR}
-        wget https://github.com/pybind/pybind11_json/archive/refs/tags/0.2.13.tar.gz
-        tar xzvf 0.2.13.tar.gz
-        cd pybind11_json-0.2.13/
+        wget https://github.com/pybind/pybind11_json/archive/refs/tags/0.2.14.tar.gz
+        tar xzvf 0.2.14.tar.gz
+        cd pybind11_json-0.2.14/
         mkdir build
         cd build
         cmake -GNinja -DCMAKE_INSTALL_PREFIX=${INSTALL_DIR} ..

.github/workflows/build_and_test.yml

@@ -4,10 +4,9 @@ on:
   pull_request:
     branches:
       - main
-      - develop
   push:
     branches:
-      - develop
+      - main
   schedule:
     # 03:00 every Saturday morning
     - cron: '0 3 * * 6'
@@ -20,7 +19,7 @@ concurrency:
 jobs:
   check_changes:
     name: Check tket library version
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     outputs:
       tket_or_workflow_changed: ${{ steps.filter.outputs.tket_or_workflow }}
       tket_changed: ${{ steps.filter.outputs.tket }}
@@ -30,7 +29,8 @@ jobs:
       tket_package_exists: ${{ steps.tket_package_exists.outputs.tket_package_exists }}
     steps:
     - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
+    - name: Select Python 3.12
+      uses: actions/setup-python@v5
       with:
         python-version: '3.12'
     - uses: dorny/paths-filter@v3.0.2
@@ -63,14 +63,14 @@ jobs:
         tket_package_exists=`conan search -r tket-libs "tket/${{ steps.tket_ver.outputs.tket_ver }}@tket/stable" | grep "not found" > /dev/null 2>&1 && echo false || echo true`
         echo "tket_package_exists=${tket_package_exists}" >> $GITHUB_OUTPUT
     - name: Check tket version bump
-      if: github.event_name == 'pull_request' && github.event.pull_request.base.ref == 'develop' && steps.filter.outputs.tket == 'true' && steps.test_package_exists.outputs.tket_package_exists == 'true'
+      if: github.event_name == 'pull_request' && steps.filter.outputs.tket == 'true' && steps.test_package_exists.outputs.tket_package_exists == 'true'
       run: exit 1
 
   check_docs_tket:
     name: Check documentation build
     needs: check_changes
     if: needs.check_changes.outputs.tket_or_workflow_changed == 'true' || needs.check_changes.outputs.doxyfile_or_workflow_changed == 'true'
-    runs-on: 'ubuntu-22.04'
+    runs-on: 'ubuntu-24.04'
     steps:
       - uses: actions/checkout@v4
       - name: Check doxygen
@@ -89,26 +89,26 @@ jobs:
         run: |
           brew update
           brew install clang-format@18
-          git ls-files "*.cpp" "*.hpp" | xargs clang-format -style=file --dry-run --Werror
+          git ls-files "*.cpp" "*.hpp" | xargs clang-format -style=file -i
+          git diff --exit-code
 
   build_test_tket:
     name: Build and test (tket)
     needs: check_changes
     if: needs.check_changes.outputs.tket_or_workflow_changed == 'true'
     strategy:
       matrix:
-        os: ['ubuntu-22.04', 'macos-12', 'macos-14']
+        os: ['ubuntu-24.04', 'macos-12', 'macos-14']
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v4
     - name: apt update
-      if: matrix.os == 'ubuntu-22.04'
+      if: matrix.os == 'ubuntu-24.04'
       run: sudo apt update
-    - name: Select Python 3.11
-      # otherwise turtlebrowser/get-conan@v1.2 fails on macos-12
+    - name: Select Python 3.12
       uses: actions/setup-python@v5
       with:
-        python-version: '3.11'
+        python-version: '3.12'
     - name: Install conan
       uses: turtlebrowser/get-conan@v1.2
     - name: Set up conan
@@ -120,7 +120,7 @@ jobs:
         cp ${PROFILE_PATH} ${DEFAULT_PROFILE_PATH}
         conan remote add tket-libs https://quantinuumsw.jfrog.io/artifactory/api/conan/tket1-libs --index 0
     - name: Install runtime test requirements
-      if: matrix.os == 'ubuntu-22.04' && github.event_name == 'schedule'
+      if: matrix.os == 'ubuntu-24.04' && github.event_name == 'schedule'
       run: |
         sudo apt install texlive texlive-latex-extra latexmk
         mkdir -p ~/texmf/tex/latex
@@ -138,7 +138,7 @@ jobs:
     - name: Build tket
       run: conan create tket -s build_type=Release --user=tket --channel=stable -o boost/*:header_only=True -o with_all_tests=True
     - name: Upload package
-      if: github.event_name == 'push' && github.ref == 'refs/heads/develop'
+      if: github.event_name == 'push'
       run: |
         ccache --set-config namespace=WITHOUT_TESTS
         conan create tket --user=tket --channel=stable -o boost/*:header_only=True
@@ -155,6 +155,10 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
+      - name: Select Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
       - name: Install conan
         uses: turtlebrowser/get-conan@v1.2
       - name: Set up conan
@@ -207,7 +211,7 @@ jobs:
           conan build tket --user=tket --channel=stable -o boost/*:header_only=True -o with_all_tests=True -c tools.cmake.cmaketoolchain:generator=Ninja
           conan export-pkg tket --user=tket --channel=stable -o boost/*:header_only=True -o with_all_tests=True -c tools.cmake.cmaketoolchain:generator=Ninja
       - name: Upload package
-        if: github.event_name == 'push' && github.ref == 'refs/heads/develop'
+        if: github.event_name == 'push'
         run: |
           ccache --set-config namespace=WITHOUT_TESTS
           conan build tket --user=tket --channel=stable -o boost/*:header_only=True
@@ -223,23 +227,27 @@ jobs:
     name: Build and test pytket (ubuntu)
     needs: check_changes
     if: needs.check_changes.outputs.tket_or_workflow_changed == 'true' || needs.check_changes.outputs.pytket_or_workflow_changed == 'true'
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
     - uses: actions/checkout@v4
+    - name: Select Python 3.12
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
     - name: Install conan
       uses: turtlebrowser/get-conan@v1.2
     - name: Set up conan
       run: |
         conan profile detect
         DEFAULT_PROFILE_PATH=`conan profile path default`
-        PROFILE_PATH=./conan-profiles/ubuntu-22.04
+        PROFILE_PATH=./conan-profiles/ubuntu-24.04
         diff ${DEFAULT_PROFILE_PATH} ${PROFILE_PATH} || true
         cp ${PROFILE_PATH} ${DEFAULT_PROFILE_PATH}
         conan remote add tket-libs https://quantinuumsw.jfrog.io/artifactory/api/conan/tket1-libs --index 0
     - name: ccache
       uses: hendrikmuhs/ccache-action@v1.2
       with:
-        key: tket-dynamic-ubuntu-22.04
+        key: tket-dynamic-ubuntu-24.04
     - name: further ccache config
       run: |
         ccache --set-config base_dir=${HOME}
@@ -257,7 +265,7 @@ jobs:
     - name: Install pytket requirements
       run: |
         conan create recipes/pybind11
-        conan create recipes/pybind11_json/all --version 0.2.13
+        conan create recipes/pybind11_json/all --version 0.2.14
     - name: Set up Python (pull request)
       if: github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch'
       uses: actions/setup-python@v5
@@ -319,7 +327,7 @@ jobs:
         name: pytket_test_coverage
         path: pytket/tests/htmlcov
     - name: Upload package
-      if: github.event_name == 'push' && github.ref == 'refs/heads/develop' && needs.check_changes.outputs.tket_changed == 'true'
+      if: github.event_name == 'push' && needs.check_changes.outputs.tket_changed == 'true'
       run: |
         conan remote login -p ${{ secrets.JFROG_ARTIFACTORY_TOKEN_3 }} tket-libs ${{ secrets.JFROG_ARTIFACTORY_USER_3 }}
         conan upload tket/${{ needs.check_changes.outputs.tket_ver }}@tket/stable -r=tket-libs
@@ -334,11 +342,10 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v4
-    - name: Select Python 3.11
-      # otherwise turtlebrowser/get-conan@v1.2 fails on macos-12
+    - name: Select Python 3.12
       uses: actions/setup-python@v5
       with:
-        python-version: '3.11'
+        python-version: '3.12'
     - name: Install conan
       uses: turtlebrowser/get-conan@v1.2
     - name: Set up conan
@@ -370,7 +377,7 @@ jobs:
     - name: Install pytket requirements
       run: |
         conan create recipes/pybind11
-        conan create recipes/pybind11_json/all --version 0.2.13
+        conan create recipes/pybind11_json/all --version 0.2.14
     - name: Set up Python (pull request)
       if: github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch'
       uses: actions/setup-python@v5
@@ -410,7 +417,7 @@ jobs:
         git diff --quiet pytket/_tket && echo "Stubs are up-to-date" || exit 1  # fail if stubs change after regeneration
         python -m mypy --config-file=mypy.ini --no-incremental -p pytket -p tests
     - name: Upload package
-      if: github.event_name == 'push' && github.ref == 'refs/heads/develop' && needs.check_changes.outputs.tket_changed == 'true'
+      if: github.event_name == 'push' && needs.check_changes.outputs.tket_changed == 'true'
       run: |
         conan remote login -p ${{ secrets.JFROG_ARTIFACTORY_TOKEN_3 }} tket-libs ${{ secrets.JFROG_ARTIFACTORY_USER_3 }}
         conan upload tket/${{ needs.check_changes.outputs.tket_ver }}@tket/stable -r=tket-libs
@@ -422,6 +429,10 @@ jobs:
     runs-on: windows-2022
     steps:
     - uses: actions/checkout@v4
+    - name: Select Python 3.12
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
     - name: Install conan
       uses: turtlebrowser/get-conan@v1.2
     - name: Set up conan
@@ -491,7 +502,7 @@ jobs:
     - name: Install pytket requirements
       run: |
         conan create recipes/pybind11
-        conan create recipes/pybind11_json/all --version 0.2.13
+        conan create recipes/pybind11_json/all --version 0.2.14
     - name: Set up Python 3.10
       if: github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch'
       uses: actions/setup-python@v5
@@ -528,7 +539,7 @@ jobs:
         pip install -r requirements.txt
         pytest --ignore=simulator/
     - name: Upload package
-      if: github.event_name == 'push' && github.ref == 'refs/heads/develop' && needs.check_changes.outputs.tket_changed == 'true'
+      if: github.event_name == 'push' && needs.check_changes.outputs.tket_changed == 'true'
       run: |
         conan remote login -p ${{ secrets.JFROG_ARTIFACTORY_TOKEN_3 }} tket-libs ${{ secrets.JFROG_ARTIFACTORY_USER_3 }}
         conan upload tket/${{ needs.check_changes.outputs.tket_ver }}@tket/stable -r=tket-libs
@@ -541,8 +552,8 @@ jobs:
     name: Publish pytket coverage
     needs: build_test_pytket_ubuntu
     concurrency: gh_pages
-    if: github.event_name == 'push' && github.ref == 'refs/heads/develop'
-    runs-on: ubuntu-22.04
+    if: github.event_name == 'push'
+    runs-on: ubuntu-24.04
     steps:
     - uses: actions/checkout@v4
       with:
@@ -569,16 +580,16 @@ jobs:
   check_pytket_coverage:
     name: Check pytket line and branch coverage
     needs: build_test_pytket_ubuntu
-    if: (github.event_name == 'pull_request' && github.event.pull_request.base.ref == 'develop') || github.event_name == 'workflow_dispatch'
-    runs-on: ubuntu-22.04
+    if: github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch'
+    runs-on: ubuntu-24.04
     steps:
     - uses: actions/checkout@v4
     - name: Download artefact
       uses: actions/download-artifact@v4
       with:
         name: pytket_test_coverage
         path: pytket-test-coverage/
-    - name: Compare with latest report from develop
+    - name: Compare with latest report from main
       run: |
         wget https://cqcl.github.io/tket/pytket/test-coverage/cov.xml -O oldcov.xml
         ./.github/workflows/compare-pytket-coverage oldcov.xml pytket-test-coverage/cov.xml
@@ -598,7 +609,7 @@ jobs:
       - publish_pytket_coverage
       - check_pytket_coverage
     if: always()
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - shell: python
         name: Check job results