Update redisvl workflow to use matrix strategy for multiple versions

Author: paoloredis

.github/workflows/redisvl_docs_sync.yaml

@@ -6,8 +6,30 @@ on:
   workflow_dispatch: # or run on manual trigger
 
 jobs:
+  define-version-matrix:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.set-matrix.outputs.matrix }}
+    steps:
+      - id: set-matrix
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          OLDEST_SUPPORTED_VERSION="0.6.0"
+          versions=$(gh release -R redis/redis-vl-python list --json name,isLatest \
+            | jq -r '.[] | [.name, .isLatest] | @tsv' \
+            | sed "/${OLDEST_SUPPORTED_VERSION}/q" \
+            | jq -Rnc '{include: [inputs | split("\t") | {version: .[0], isLatest: .[1]}]}')
+
+          echo "${versions}"
+          echo "matrix=${versions}" >> "$GITHUB_OUTPUT"
+
   redisvl_docs_sync:
     runs-on: ubuntu-latest
+    needs: define-version-matrix
+    strategy:
+      matrix: ${{ fromJSON(needs['define-version-matrix'].outputs.matrix) }}
+      fail-fast: false
     permissions:
       contents: write
       pull-requests: write
@@ -30,20 +52,25 @@ jobs:
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          pushd redis-vl-python
+          version="${{ matrix.version }}"
+          isLatest="${{ matrix.isLatest }}"
 
-          # Get latest release
-          latest_release=$(gh release -R redis/redis-vl-python list --json name,isLatest --jq '.[] | select(.isLatest)|.name')
-          git checkout "tags/${latest_release}" || git checkout "tags/v${latest_release}"
+          pushd redis-vl-python
+          git checkout "tags/${version}" || git checkout "tags/v${version}"
           pip3 install -e .
-
           popd
-          sphinx-build -M markdown ./redis-vl-python/docs ./build
-          
-          echo "release=${latest_release}" >> "$GITHUB_OUTPUT"
+
+          if [ ${isLatest} = true ]; then
+            sphinx-build -M markdown ./redis-vl-python/docs ./build-latest
+          else
+            sphinx-build -M markdown ./redis-vl-python/docs ./build-${version}
+          fi
 
       - name: 'Format markdown files for hugo compatibility'
         run: |
+          version="${{ matrix.version }}"
+          isLatest="${{ matrix.isLatest }}"
+
           #!/bin/bash
           mkdir -p redis_vl_hugo/user_guide/
           mkdir redis_vl_hugo/overview/
@@ -65,13 +92,22 @@ jobs:
               alias=$(echo ${src} | sed -E 's|./redis_vl_hugo/|/integrate/redisvl/| ; s|\.md$|| ; s|\/_index$||')
 
               # Inject frontmatter in destination file
+              if [ ${isLatest} = true ]; then
               cat >_tmp <<EOL
           ---
           linkTitle: ${linkTitle}
           title: ${title}
           aliases:
           - ${alias}
           EOL
+              else
+              cat >_tmp <<EOL
+          ---
+          linkTitle: ${linkTitle}
+          title: ${title}
+          EOL
+              fi
+
 
               # Inject weight property for index pages to preserve order
               case "${title}" in
@@ -110,12 +146,13 @@ jobs:
           }
 
           # Convert jupyter notebooks to markdown
-          jupyter nbconvert --to markdown build/jupyter_execute/user_guide/*.ipynb --output-dir redis_vl_hugo/user_guide/ 2>/dev/null
-          jupyter nbconvert --to markdown build/jupyter_execute/overview/cli.ipynb --output-dir redis_vl_hugo/overview/ 2>/dev/null
+          build_folder=$(echo build-*)
+          jupyter nbconvert --to markdown ${build_folder}/jupyter_execute/user_guide/*.ipynb --output-dir redis_vl_hugo/user_guide/ 2>/dev/null
+          jupyter nbconvert --to markdown ${build_folder}/jupyter_execute/overview/cli.ipynb --output-dir redis_vl_hugo/overview/ 2>/dev/null
 
           # Prepare markdown files
-          rsync -a ./build/markdown/api/ ./redis_vl_hugo/api/ --exclude=index.md
-          cp ./build/markdown/overview/installation.md ./redis_vl_hugo/overview/installation.md
+          rsync -a ./${build_folder}/markdown/api/ ./redis_vl_hugo/api/ --exclude=index.md
+          cp ./${build_folder}/markdown/overview/installation.md ./redis_vl_hugo/overview/installation.md
 
           # Format markdown files
           shopt -s globstar
@@ -211,9 +248,9 @@ jobs:
           done
 
           # Format _index.md pages
-          cp ./build/markdown/api/index.md ./redis_vl_hugo/api/_index.md
-          cp ./build/markdown/user_guide/index.md ./redis_vl_hugo/user_guide/_index.md
-          cp ./build/markdown/overview/index.md ./redis_vl_hugo/overview/_index.md
+          cp ./${build_folder}/markdown/api/index.md ./redis_vl_hugo/api/_index.md
+          cp ./${build_folder}/markdown/user_guide/index.md ./redis_vl_hugo/user_guide/_index.md
+          cp ./${build_folder}/markdown/overview/index.md ./redis_vl_hugo/overview/_index.md
 
           index_markdown_pages=(
               ./redis_vl_hugo/api/_index.md
@@ -237,13 +274,19 @@ jobs:
               fi
           done
 
-          cp -r redis_vl_hugo/* content/develop/ai/redisvl/
+          if [ ${isLatest} = true ]; then
+            cp -r redis_vl_hugo/* content/develop/ai/redisvl/
+          else
+            mkdir content/develop/ai/redisvl/${version}/
+            cp -r redis_vl_hugo/* content/develop/ai/redisvl/${version}/
+            python3 build/version_archiver.py redisvl ${version} --skip-archive
+          fi
 
       - name: 'Create pull request if necessary'
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          release="${{ steps.sphinx.outputs.release }}"
+          release="${{ matrix.version }}"
           branch="redisvl_docs_sync_${release}"
           redisvl_change=false
 
@@ -254,7 +297,7 @@ jobs:
           if [ "$?" -eq 0 ]; then
             set -e
             # if it does, create local branch off existing remote branch
-            git checkout -b "${branch}" "origin/${branch}"
+            git checkout -f -b "${branch}" "origin/${branch}"
             git branch --set-upstream-to="origin/${branch}" "${branch}"
             git pull
           else
@@ -263,9 +306,11 @@ jobs:
             git checkout -b "${branch}"
           fi
 
-          redisvl_is_different=$(git diff content/develop/ai/redisvl/)
+          set +e
+          latest_redisvl_release_is_different=$(git diff content/develop/ai/redisvl/)
+          new_release=$(git ls-files --others --directory | grep content/develop/ai/redisvl/${release})
 
-          if [[ ! -z $redisvl_is_different ]]; then
+          if [[ -n "$latest_redisvl_release_is_different" || -n "$new_release" ]]; then
             redisvl_change=true
 
             git add "content/develop/ai/redisvl/"