ci: Add workflow to serve documentation preview in PRs

Author: thomass-dev

.github/actions/sphinx/deploy/action.yml

@@ -14,8 +14,7 @@ inputs:
     required: false
     default: scaleway
   BUCKET:
-    required: false
-    default: prod-probabl-skore
+    required: true
   SOURCE:
     required: true
   DESTINATION:

.github/workflows/pr-display-backend-coverage.yml

@@ -13,7 +13,7 @@ permissions: {}
 
 jobs:
   acquire-pr-number:
-    if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
+    if: ${{ github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success' }}
     runs-on: ubuntu-latest
     outputs:
       PR_NUMBER: ${{ steps.acquire-pr-number.outputs.number }}
@@ -33,7 +33,7 @@ jobs:
             }}
 
   display-backend-coverage:
-    if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
+    if: ${{ github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success' }}
     runs-on: ubuntu-latest
     needs: [acquire-pr-number]
     permissions:

.github/workflows/pr-display-frontend-coverage.yml

@@ -13,7 +13,7 @@ permissions: {}
 
 jobs:
   acquire-pr-number:
-    if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
+    if: ${{ github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success' }}
     runs-on: ubuntu-latest
     outputs:
       PR_NUMBER: ${{ steps.acquire-pr-number.outputs.number }}
@@ -33,7 +33,7 @@ jobs:
             }}
 
   display-frontend-coverage:
-    if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
+    if: ${{ github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success' }}
     runs-on: ubuntu-latest
     needs: [acquire-pr-number]
     permissions:

.github/workflows/sphinx.yml

@@ -115,9 +115,40 @@ jobs:
           name: sphinx-html-artifact
           path: sphinx/build/html/
 
-  sphinx-deploy-html:
+  sphinx-preview:
+    if: ${{ github.event_name == 'pull_request' }}
     runs-on: ubuntu-latest
+    needs: sphinx-build
+    permissions:
+      actions: read
+      contents: read
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: sphinx-html-artifact
+          path: html/
+
+      - uses: ./.github/actions/sphinx/deploy
+        with:
+          CONFIGURATION: ${{ secrets.RCLONE_CONFIG_DOC_PREVIEW }}
+          BUCKET: ${{ vars.DOCUMENTATION_PREVIEW_BUCKET }}
+          SOURCE: html/
+          DESTINATION: ${{ github.event.number }}/
+
+      - uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          number: ${{ github.event.number }}
+          header: documentation-preview
+          message: >-
+            [Documentation preview](${{ vars.DOCUMENTATION_PREVIEW_URL }}/${{ github.event.number }})
+            @ ${{ github.event.pull_request.head.sha }}
+
+  sphinx-deploy-html:
     if: ${{ (github.event_name == 'release') || (github.event_name == 'push' && github.ref == 'refs/heads/main') }}
+    runs-on: ubuntu-latest
     needs: [sphinx-version, sphinx-build]
     steps:
       - uses: actions/checkout@v4
@@ -128,12 +159,13 @@ jobs:
       - uses: ./.github/actions/sphinx/deploy
         with:
           CONFIGURATION: ${{ secrets.RCLONE_CONFIG_DOCS }}
+          BUCKET: ${{ vars.DOCUMENTATION_BUCKET }}
           SOURCE: html/
           DESTINATION: ${{ needs.sphinx-version.outputs.SPHINX_VERSION }}/
 
   sphinx-deploy-root-files:
-    runs-on: ubuntu-latest
     if: ${{ github.event_name == 'release' }}
+    runs-on: ubuntu-latest
     needs: [sphinx-version, sphinx-build, sphinx-deploy-html]
     steps:
       - uses: actions/checkout@v4
@@ -144,7 +176,7 @@ jobs:
             import operator
             import json
 
-            url = "https://skore.probabl.ai"
+            url = os.environ["URL"]
             current = os.environ["CURRENT"]
 
             response = requests.get(f"{url}/versions.json")
@@ -177,18 +209,20 @@ jobs:
                   """
               )
         env:
+          URL: ${{ vars.DOCUMENTATION_URL }}
           CURRENT: ${{ needs.sphinx-version.outputs.SPHINX_VERSION }}
       - uses: ./.github/actions/sphinx/deploy
         with:
           CONFIGURATION: ${{ secrets.RCLONE_CONFIG_DOCS }}
+          BUCKET: ${{ vars.DOCUMENTATION_BUCKET }}
           ACTION: copy
           SOURCE: artifacts/
           DESTINATION:
 
   sphinx-clean:
     runs-on: ubuntu-latest
     if: always()
-    needs: [sphinx-version, sphinx-build, sphinx-deploy-html, sphinx-deploy-root-files]
+    needs: [sphinx-version, sphinx-build, sphinx-preview, sphinx-deploy-html, sphinx-deploy-root-files]
     steps:
       - uses: geekyeggo/delete-artifact@v5
         with: