Fix CI actions on GitHub (#672)

* update linux runners to ubuntu-22 or ubuntu-latest, but run test-mem job on ubuntu-20 for it for some reason fails on ubuntu-22 * bump up CI actions to be compatible with node 20, namely bump up to actions/checkout@v4, actions/setup-python@v5, download-artifact@v4, upload-artifact@v4 * update steps involving download-artifact and upload-artifact actions per https://github.com/actions/download-artifact/blob/main/docs/MIGRATION.md * migrate to docker compose v2 * to build binary wheels for mac os, set MACOSX_DEPLOYMENT_TARGET according to the macos version * stop building and testing wheels for old Python versions 3.7, 3.8
quantumlib · Sep 14, 2024 · cd646a9 · cd646a9
1 parent 80e3026
commit cd646a9
Show file tree

Hide file tree

Showing 7 changed files with 52 additions and 42 deletions.
diff --git a/.github/workflows/bazeltest.yml b/.github/workflows/bazeltest.yml
@@ -12,7 +12,7 @@ jobs:
   # Run tests with Bazel v5.3.0.
   test:
     name: Test with Bazel
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
         # Hardware optimizers.
@@ -21,7 +21,7 @@ jobs:
         parallel_opt: [openmp,nopenmp]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Checkout submodules
         run: git submodule update --init --recursive
       - name: Install Bazel on CI
@@ -43,14 +43,14 @@ jobs:
 
   test-san:
     name: Sanitizer tests
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
         # Test sanitizers
         sanitizer_opt: [msan,asan]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Checkout submodules
         run: git submodule update --init --recursive
       - name: Install Bazel on CI
@@ -75,7 +75,7 @@ jobs:
     runs-on: ubuntu-20.04
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Checkout submodules
         run: git submodule update --init --recursive
       - name: Install Bazel on CI

diff --git a/.github/workflows/cirq_compatibility.yml b/.github/workflows/cirq_compatibility.yml
@@ -7,10 +7,10 @@ on:
 jobs:
   consistency:
     name: Nightly Compatibility
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.7'
           architecture: 'x64'

diff --git a/.github/workflows/dockertest.yml b/.github/workflows/dockertest.yml
@@ -20,11 +20,11 @@ jobs:
         os: [ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Checkout submodules
         run: git submodule update --init --recursive
       - name: Build Docker images
-        run: docker-compose build
+        run: docker compose build
       - name: Run C++ tests
         run: docker run --rm qsim-cxx-tests:latest
       - name: Run Python tests
@@ -34,4 +34,4 @@ jobs:
       - name: Test install process
         run: |
           cd install/tests
-          docker-compose up --build
+          docker compose up --build
diff --git a/.github/workflows/python_format.yml b/.github/workflows/python_format.yml
@@ -17,10 +17,10 @@ jobs:
     name: Format check
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/setup-python@v1
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.7'
           architecture: 'x64'

diff --git a/.github/workflows/release_wheels.yml b/.github/workflows/release_wheels.yml
@@ -14,46 +14,51 @@ jobs:
         include:
           - os: macos-12 # x86_64
             name: mac
+            env:
+              macosx_deployment_target: "12.0"
             cibw:
-              build: "cp37* cp38* cp39* cp310* cp311* cp312*"
+              build: "cp39* cp310* cp311* cp312*"
           - os: macos-13-large # Apple Silicon
             name: mac_arm64
+            env:
+              macosx_deployment_target: "13.0"
             cibw:
-              build: "cp37* cp38* cp39* cp310* cp311* cp312*"
-          - os: ubuntu-20.04
+              build: "cp39* cp310* cp311* cp312*"
+          - os: ubuntu-22.04
             name: manylinux2014
             cibw:
               arch: x86_64
-              build: "cp37* cp38* cp39* cp310* cp311* cp312*"
+              build: "cp39* cp310* cp311* cp312*"
               manylinux_image: manylinux2014
           - os: windows-2019
             name: win_amd64
             architecture: x64
             cibw:
-              build: "cp37-win_amd64 cp38-win_amd64 cp39-win_amd64 cp310-win_amd64 cp311-win_amd64 cp312-win_amd64"
+              build: "cp39-win_amd64 cp310-win_amd64 cp311-win_amd64 cp312-win_amd64"
     env:
+      MACOSX_DEPLOYMENT_TARGET: "${{ matrix.env.macosx_deployment_target }}"
       CIBW_BUILD: "${{ matrix.cibw.build || '*' }}"
       CIBW_SKIP: "*musllinux*"
       CIBW_ARCHS: "${{ matrix.cibw.arch || 'auto' }}"
       CIBW_MANYLINUX_X86_64_IMAGE: "${{ matrix.cibw.manylinux_image }}"
-      CIBW_BEFORE_BUILD_MACOS: "brew install libomp llvm && brew link --overwrite [email protected] && brew link --force libomp"
+      CIBW_BEFORE_BUILD_MACOS: "brew install libomp llvm@12 && brew link --overwrite [email protected] && brew link --force libomp"
       CIBW_REPAIR_WHEEL_COMMAND_MACOS: "delocate-listdeps {wheel} && delocate-wheel --verbose --require-archs {delocate_archs} -w {dest_dir} {wheel}"
       # to install latest delocate package
       CIBW_DEPENDENCY_VERSIONS: "latest"
       # due to package and module name conflict have to temporarily move it away to run tests
-      CIBW_BEFORE_TEST: mv {package}/qsimcirq /tmp
+      CIBW_BEFORE_TEST: "mv {package}/qsimcirq /tmp"
       CIBW_TEST_EXTRAS: "dev"
       CIBW_TEST_COMMAND: "pytest {package}/qsimcirq_tests/qsimcirq_test.py && mv /tmp/qsimcirq {package}"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       # Used to host cibuildwheel
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.11'
 
       - name: Install cibuildwheel and twine
-        run: python -m pip install cibuildwheel==2.16.2
+        run: python -m pip install cibuildwheel==2.20.0
 
       - name: Install requirements
         run: python -m pip install -r requirements.txt
@@ -64,20 +69,21 @@ jobs:
       - name: Build wheels
         run: python -m cibuildwheel --output-dir wheelhouse
 
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v4
         with:
-          name: python-wheels
+          name: python-wheels-${{ matrix.name }}
           path: ./wheelhouse/*.whl
   release-wheels:
     name: Publish all wheels
     needs: [build_wheels]
     runs-on: ubuntu-latest
     steps:
     - name: Download build artifacts
-      uses: actions/download-artifact@v2
+      uses: actions/download-artifact@v4
       with:
-        name: python-wheels
         path: dist/
+        pattern: python-wheels-*
+        merge-multiple: true
     - name: Publish wheels
       uses: pypa/gh-action-pypi-publish@release/v1
       with:

diff --git a/.github/workflows/testing_wheels.yml b/.github/workflows/testing_wheels.yml
@@ -19,29 +19,34 @@ jobs:
         include:
           - os: macos-12 # x86_64
             name: mac
+            env:
+              macosx_deployment_target: "12.0"
             cibw:
-              build: "cp37* cp38* cp39* cp310* cp311* cp312*"
+              build: "cp39* cp310* cp311* cp312*"
           - os: macos-13-large # Apple Silicon
             name: mac_arm64
+            env:
+              macosx_deployment_target: "13.0"
             cibw:
-              build: "cp37* cp38* cp39* cp310* cp311* cp312*"
-          - os: ubuntu-20.04
+              build: "cp39* cp310* cp311* cp312*"
+          - os: ubuntu-22.04
             name: manylinux2014
             cibw:
               arch: x86_64
-              build: "cp37* cp38* cp39* cp310* cp311* cp312*"
+              build: "cp39* cp310* cp311* cp312*"
               manylinux_image: manylinux2014
           - os: windows-2019
             name: win_amd64
             architecture: x64
             cibw:
-              build: "cp37-win_amd64 cp38-win_amd64 cp39-win_amd64 cp310-win_amd64 cp311-win_amd64 cp312-win_amd64"
+              build: "cp39-win_amd64 cp310-win_amd64 cp311-win_amd64 cp312-win_amd64"
     env:
+      MACOSX_DEPLOYMENT_TARGET: "${{ matrix.env.macosx_deployment_target }}"
       CIBW_BUILD: "${{ matrix.cibw.build || '*' }}"
       CIBW_SKIP: "*musllinux*"
       CIBW_ARCHS: "${{ matrix.cibw.arch || 'auto' }}"
       CIBW_MANYLINUX_X86_64_IMAGE: "${{ matrix.cibw.manylinux_image }}"
-      CIBW_BEFORE_BUILD_MACOS: "brew install libomp llvm && brew link --overwrite [email protected] && brew link --force libomp"
+      CIBW_BEFORE_BUILD_MACOS: "brew install libomp llvm@12 && brew link --overwrite [email protected] && brew link --force libomp"
       CIBW_REPAIR_WHEEL_COMMAND_MACOS: "delocate-listdeps {wheel} && delocate-wheel --verbose --require-archs {delocate_archs} -w {dest_dir} {wheel}"
       # to install latest delocate package
       CIBW_DEPENDENCY_VERSIONS: "latest"
@@ -50,15 +55,15 @@ jobs:
       CIBW_TEST_EXTRAS: "dev"
       CIBW_TEST_COMMAND: "pytest {package}/qsimcirq_tests/qsimcirq_test.py && mv /tmp/qsimcirq {package}"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       # Used to host cibuildwheel
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.11'
 
       - name: Install cibuildwheel and twine
-        run: python -m pip install cibuildwheel==2.16.2
+        run: python -m pip install cibuildwheel==2.20.0
 
       - name: Install requirements
         run: python -m pip install -r requirements.txt
@@ -69,8 +74,7 @@ jobs:
       - name: Build wheels
         run: python -m cibuildwheel --output-dir wheelhouse
 
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v4
         with:
-          name: python-wheels
+          name: python-wheels-${{ matrix.name }}
           path: ./wheelhouse/*.whl
-
diff --git a/docs/docker.md b/docs/docker.md
@@ -19,10 +19,10 @@ git submodule update --init --recursive
 To build qsim and run all the tests:
 
 ```
-# docker-compose up --build
+# docker compose up --build
 ```
 
-`docker-compose` will create the `qsim`, `qsim-cxx-tests`, and `qsim-py-tests`
+`docker compose` will create the `qsim`, `qsim-cxx-tests`, and `qsim-py-tests`
 images and automatically run all tests. A successful run should have the
 following messages somewhere in the logs:
 
@@ -34,7 +34,7 @@ qsim-py-tests exited with code 0
 To build without running tests, simply run:
 
 ```
-# docker-compose build
+# docker compose build
 ```
 
 ## Run Simulations