From f32de33470e2798efef13a946f8f4076879ff38a Mon Sep 17 00:00:00 2001
From: Jake Lishman <jake.lishman@ibm.com>
Date: Mon, 29 Jul 2024 12:19:33 +0100
Subject: [PATCH] Pin version of setuptools to known-good version

---
 .github/workflows/docs.yml | 14 ++++++++++
 .github/workflows/main.yml | 56 ++++++++++++++++++++++++++++++++++++++
 action.yml                 | 14 ++++++++++
 3 files changed, 84 insertions(+)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 681f6fb..3199b2f 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -15,6 +15,20 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: '3.8'
+
+    # This can be removed when `ibm-platform-services` can build/install with the most recent of
+    # `setuptools`. `setuptools==72.0.0` and `ibm-platform-services==0.55.1` are a known-bad combo.
+    - name: Prebuild old-setuptools dependencies
+      shell: bash
+      run: |
+        set -e
+        python -m venv .build-deps
+        source .build-deps/bin/activate
+        pip install 'setuptools<72.0' wheel
+        pip wheel --no-build-isolation ibm-platform-services
+        deactivate
+        rm -rf .build-deps
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 688cba3..34dba00 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -38,6 +38,20 @@ jobs:
             ${{ runner.os }}-${{ matrix.python-version }}-pip-tests-
             ${{ runner.os }}-${{ matrix.python-version }}-pip-
             ${{ runner.os }}-${{ matrix.python-version }}
+
+      # This can be removed when `ibm-platform-services` can build/install with the most recent of
+      # `setuptools`. `setuptools==72.0.0` and `ibm-platform-services==0.55.1` are a known-bad combo.
+      - name: Prebuild old-setuptools dependencies
+        shell: bash
+        run: |
+          set -e
+          python -m venv .build-deps
+          source .build-deps/bin/activate
+          pip install 'setuptools<72.0' wheel
+          pip wheel --no-build-isolation ibm-platform-services
+          deactivate
+          rm -rf .build-deps
+
       - name: Install Deps
         run: python -m pip install -U tox setuptools virtualenv wheel
       - name: Install and Run Tests
@@ -61,6 +75,20 @@ jobs:
             ${{ runner.os }}-${{ matrix.python-version }}-pip-neko-
             ${{ runner.os }}-${{ matrix.python-version }}-pip-
             ${{ runner.os }}-${{ matrix.python-version }}-
+
+      # This can be removed when `ibm-platform-services` can build/install with the most recent of
+      # `setuptools`. `setuptools==72.0.0` and `ibm-platform-services==0.55.1` are a known-bad combo.
+      - name: Prebuild old-setuptools dependencies
+        shell: bash
+        run: |
+          set -e
+          python -m venv .build-deps
+          source .build-deps/bin/activate
+          pip install 'setuptools<72.0' wheel
+          pip wheel --no-build-isolation ibm-platform-services
+          deactivate
+          rm -rf .build-deps
+
       - name: Install Deps
         run: python -m pip install -U tox
       - name: Run neko
@@ -87,6 +115,20 @@ jobs:
             ${{ runner.os }}-${{ matrix.python-version }}-pip-lint-
             ${{ runner.os }}-${{ matrix.python-version }}-pip-
             ${{ runner.os }}-${{ matrix.python-version }}-
+
+      # This can be removed when `ibm-platform-services` can build/install with the most recent of
+      # `setuptools`. `setuptools==72.0.0` and `ibm-platform-services==0.55.1` are a known-bad combo.
+      - name: Prebuild old-setuptools dependencies
+        shell: bash
+        run: |
+          set -e
+          python -m venv .build-deps
+          source .build-deps/bin/activate
+          pip install 'setuptools<72.0' wheel
+          pip wheel --no-build-isolation ibm-platform-services
+          deactivate
+          rm -rf .build-deps
+
       - name: Install Deps
         run: python -m pip install -U tox
       - name: Run lint
@@ -112,6 +154,20 @@ jobs:
             ${{ runner.os }}-pip-docs-
             ${{ runner.os }}-pip-
             ${{ runner.os }}-
+
+      # This can be removed when `ibm-platform-services` can build/install with the most recent of
+      # `setuptools`. `setuptools==72.0.0` and `ibm-platform-services==0.55.1` are a known-bad combo.
+      - name: Prebuild old-setuptools dependencies
+        shell: bash
+        run: |
+          set -e
+          python -m venv .build-deps
+          source .build-deps/bin/activate
+          pip install 'setuptools<72.0' wheel
+          pip wheel --no-build-isolation ibm-platform-services
+          deactivate
+          rm -rf .build-deps
+
       - name: Install Deps
         run: |
           python -m pip install -U tox
diff --git a/action.yml b/action.yml
index 4d8cf49..a12833b 100644
--- a/action.yml
+++ b/action.yml
@@ -21,6 +21,20 @@ runs:
       run: |
         pip install -U setuptools pip
       shell: bash
+
+    # This can be removed when `ibm-platform-services` can build/install with the most recent of
+    # `setuptools`. `setuptools==72.0.0` and `ibm-platform-services==0.55.1` are a known-bad combo.
+    - name: Prebuild old-setuptools dependencies
+      shell: bash
+      run: |
+        set -e
+        python -m venv .build-deps
+        source .build-deps/bin/activate
+        pip install 'setuptools<72.0' wheel
+        pip wheel --no-build-isolation ibm-platform-services
+        deactivate
+        rm -rf .build-deps
+
     - name: Install neko and its dependencies
       run: |
         pip install ./qiskit-neko