chore(ci): Add check that api doc is up to date to concrete-python tests

zama-ai · Nov 28, 2024 · 15d7452 · 15d7452
1 parent d866b32
commit 15d7452
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 1 deletion.
diff --git a/.github/workflows/concrete_python_release_cpu.yml b/.github/workflows/concrete_python_release_cpu.yml
@@ -143,7 +143,7 @@ jobs:
       - name: Check documentation
         run: |
           WHEEL_DIR=$(pwd)/${{ format('wheel-{0}-linux-x86', matrix.python-version) }}
-          CONCRETE_WHEEL="${WHEEL_DIR}"/*.whl .github/workflows/scripts/make_apidocs.sh
+          CONCRETE_WHEEL="${WHEEL_DIR}/*.whl" .github/workflows/scripts/make_apidocs.sh
       - name: Upload docs.patch if failure
         if: ${{ failure() }}
         uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0

diff --git a/.github/workflows/concrete_python_tests_linux.yml b/.github/workflows/concrete_python_tests_linux.yml
@@ -110,6 +110,65 @@ jobs:
           SLACK_COLOR: ${{ job.status }}
           SLACK_MESSAGE: "build-python-bindings finished with status: ${{ job.status }}. (${{ env.ACTION_RUN_URL }})"
 
+  test-apidoc-up-to-date:
+    needs: [ build-python-bindings ]
+    runs-on: ubuntu-latest
+    env:
+      python-version: 3.8
+    steps:
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - name: Setup Python
+        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
+        with:
+          python-version: ${{ env.python-version }}
+      - name: Download concrete-compiler python-bindings
+        uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
+        with:
+          name: concrete-compiler-python-bindings
+          path: compiler-artifacts
+      - name: Extract artifacts archive
+        run: |
+          cd compiler-artifacts
+          echo "$PWD"
+          tar xzvf artifacts.tgz
+      - name: Build wheel
+        run: |
+            set -e
+            echo "$PWD"
+            export COMPILER_BUILD_DIRECTORY=${{ github.workspace }}/compiler-artifacts
+            echo "$COMPILER_BUILD_DIRECTORY"
+            tree $COMPILER_BUILD_DIRECTORY
+            echo "DEBUG END"
+            dnf -y install graphviz graphviz-devel
+            cd ${{ github.workspace }}/frontends/concrete-python
+            make PYTHON=${{ format('python{0}', env.python-version) }} venv
+            source .venv/bin/activate
+            make whl
+      - name: Check documentation
+        run: |
+          WHEEL_DIR=${{ github.workspace }}/frontends/concrete-python/dist/
+          CONCRETE_WHEEL="${WHEEL_DIR}"/*.whl .github/workflows/scripts/make_apidocs.sh
+      - name: Upload docs.patch if failure
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0
+        with:
+          name: docs-artifacts
+          path: |
+            docs.patch
+            docs/dev/api
+          retention-days: 3
+      - name: Slack Notification
+        if: ${{ failure() && github.ref == 'refs/heads/main' }}
+        continue-on-error: true
+        uses: rtCamp/action-slack-notify@c33737706dea87cd7784c687dadc9adf1be59990
+        env:
+          SLACK_COLOR: ${{ job.status }}
+          SLACK_MESSAGE: "test-apidoc-up-to-date finished with status: ${{ job.status }}. (${{ env.ACTION_RUN_URL }})"
+
   test-pytest:
     needs: [setup-instance, build-python-bindings]
     runs-on: ${{ needs.setup-instance.outputs.runner-name }}