ci: Add workflow to test code snippets (#6364)

* initial

* Add workflow to test code snippets

---------

Co-authored-by: Timo Möller <timo.moeller@deepset.ai>
Co-authored-by: Massimiliano Pippi <mpippi@gmail.com>

.github/workflows/examples_tests.yml

@@ -7,7 +7,8 @@ on:
       - main
   pull_request:
     paths:
-      - examples/**
+      - "examples/**"
+      - "!examples/preview/**"
     types:
       - opened
       - reopened
@@ -47,7 +48,7 @@ jobs:
           pip install .[inference,dev,elasticsearch,preprocessing,file-conversion]
 
       - name: Run
-        run: pytest examples/
+        run: pytest examples/  --ignore examples/preview/
 
       - name: Calculate alert data
         id: calculator

.github/workflows/snippets_tests.yml

@@ -0,0 +1,81 @@
+name: Test documentation snippets for Haystack 2.x
+
+on:
+  workflow_dispatch: # Activate this workflow manually
+  push:
+    branches:
+      - main
+  pull_request:
+    paths:
+      - examples/preview/**
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - ready_for_review
+
+env:
+  OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+  PYTHON_VERSION: "3.8"
+
+jobs:
+  tests:
+    name: Snippets
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install snippets dependencies
+        run: |
+          pip install --upgrade pip
+          pip install ".[preview]" torch
+
+      - name: Get changed files
+        id: files
+        uses: tj-actions/changed-files@v40
+        with:
+          files: |
+            examples/preview/**.py
+
+      - name: Run each snippet
+        run: |
+          CHANGED_FILES=${{ steps.files.outputs.all_changed_files }}
+          for file in $CHANGED_FILES; do
+            python "$file"
+          done
+
+      - name: Calculate alert data
+        id: calculator
+        if: (success() || failure()) && github.ref_name == 'main'
+        shell: bash
+        run: |
+          if [ "${{ job.status }}" = "success" ]; then
+            echo "alert_type=success" >> "$GITHUB_OUTPUT";
+          else
+            echo "alert_type=error" >> "$GITHUB_OUTPUT";
+          fi
+
+      - name: Send event to Datadog
+        if: (success() || failure()) && github.ref_name == 'main'
+        uses: masci/datadog@v1
+        with:
+          api-key: ${{ secrets.CORE_DATADOG_API_KEY }}
+          api-url: https://api.datadoghq.eu
+          events: |
+            - title: "${{ github.workflow }} workflow"
+              text: "Job ${{ github.job }} in branch ${{ github.ref_name }}"
+              alert_type: "${{ steps.calculator.outputs.alert_type }}"
+              source_type_name: "Github"
+              host: ${{ github.repository_owner }}
+              tags:
+                - "project:${{ github.repository }}"
+                - "job:${{ github.job }}"
+                - "run_id:${{ github.run_id }}"
+                - "workflow:${{ github.workflow }}"
+                - "branch:${{ github.ref_name }}"
+                - "url:https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"