[ENHANCEMENT] CI: Allow to publish hidden version for docs/ branches (#5088)

Co-authored-by: nataliaElv <[email protected]>
Co-authored-by: davidberenstein1957 <[email protected]>

Author: 3 people

.github/workflows/argilla.docs.yml

@@ -13,6 +13,7 @@ on:
     branches:
       - "main"
       - "develop"
+      - "docs/**"
 
 defaults:
   run:
@@ -54,13 +55,46 @@ jobs:
         run: echo "${{ github.ref }}"
           echo "${{ github.head_ref }}"
 
-      - run: |
+      - name: Deploy Argilla docs (branch /main)
+        run: |
           pdm run mike deploy latest --push
           pdm run mike set-default --push latest
         if: github.ref == 'refs/heads/main'
 
-      - run: pdm run mike deploy dev --push
+      - name: Deploy Argilla docs (branch /develop)
+        run: pdm run mike deploy dev --push
         if: github.ref == 'refs/heads/develop'
 
-      - run: pdm run mike deploy ${{ github.ref_name }}
+      - name: Deploy Argilla docs (release vX.Y.Z)
+        run: pdm run mike deploy ${{ github.ref_name }}
         if: startsWith(github.ref, 'refs/tags/')
+
+      - name: Delete Argilla docs (versions 'docs_*')
+        id: delete_deployment
+        run: |
+          versions=$(pdm run mike list)
+          formatted_versions=$(echo "$versions" | tr ',' '\n' | tr -d '[]')
+          for version in $versions; do
+            if [[ $version == docs_* ]]; then
+              echo "Deleting version: $version"
+              pdm run mike delete "$version" --push
+            fi
+          done
+        if: startsWith(github.ref, 'refs/tags/')
+
+      - name: Extract branch name
+        id: extract_branch_name
+        shell: bash
+        run: echo "branch_name=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" | sed 's/\//_/g'  >> $GITHUB_OUTPUT
+
+      - name: Deploy Argilla docs (branch /docs/*)
+        run: pdm run mike deploy ${{ steps.extract_branch_name.outputs.branch_name }} --prop-set hidden=true --push
+        if: startsWith(github.ref, 'refs/heads/docs') || startsWith(github.head_ref, 'docs/')
+
+      - name: Add deployment message in PR
+        uses: mshick/add-pr-comment@v2
+        if: startsWith(github.ref, 'refs/heads/docs') || startsWith(github.head_ref, 'docs/')
+        with:
+          message: |
+            Docs for this PR have been deployed hidden from versioning: [https://argilla-io.github.io/argilla/${{ steps.extract_branch_name.outputs.branch_name }}](https://argilla-io.github.io/argilla/${{ steps.extract_branch_name.outputs.branch_name }})
+