Update the build to deploy to preview

Author: jeremi

.github/workflows/build_deploy.yml

@@ -30,52 +30,59 @@ jobs:
       # - name: Run linkcheck
       #   run: make linkcheck
 
-      - name: Prepare deploy
-        run: make deploy
+      # Set safe branch name for preview deployments
+      - name: Set safe branch name
+        if: github.ref != 'refs/heads/main'
+        id: branch
+        run: |
+          # Sanitize branch name: only allow alphanumeric, dots, underscores, hyphens
+          # Replace all other characters with hyphens and limit to 50 characters
+          SAFE_NAME=$(echo ${GITHUB_REF_NAME} | sed 's/[^a-zA-Z0-9._-]/-/g' | cut -c1-50)
+          echo "safe=${SAFE_NAME}" >> $GITHUB_OUTPUT
 
-      # # node setup
-      # - name: Use Node.js 16
-      #   uses: actions/setup-node@v3
-      #   with:
-      #     node-version: '16'
-      # - name: Install Yarn
-      #   run: npm install -g yarn
-      # # node cache
-      # - name: Get yarn cache directory path
-      #   id: yarn-cache-dir-path
-      #   working-directory: submodules/volto
-      #   run: echo "dir=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT
-      # - uses: actions/cache@v3
-      #   id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
-      #   with:
-      #     path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-      #     key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-      #     restore-keys: |
-      #       ${{ runner.os }}-yarn-
+      # Build documentation with appropriate environment variables
+      - name: Prepare deploy (main/stable)
+        if: github.ref == 'refs/heads/main'
+        run: |
+          set -e  # Exit on error
+          export DOCS_VERSION=stable
+          export DOCS_BASEURL=https://docs.openspp.org/
+          export IS_PREVIEW=0
+          make deploy || { echo "Build failed"; exit 1; }
 
-      # - name: StoryBook build
-      #   run: |
-      #     cd submodules/volto 
-      #     yarn install --immutable 
-      #     yarn build-storybook -o ../../_build/html/storybook
+      - name: Prepare deploy (preview)
+        if: github.ref != 'refs/heads/main'
+        run: |
+          set -e  # Exit on error
+          export DOCS_VERSION=${{ steps.branch.outputs.safe }}
+          export DOCS_BASEURL=https://docs.openspp.org/previews/${{ steps.branch.outputs.safe }}/
+          export IS_PREVIEW=1
+          make deploy || { echo "Build failed"; exit 1; }
 
-      # - name: Deploy to server
-      #   id: deploy
-      #   uses: Pendect/action-rsyncer@v2.0.0
-      #   env:
-      #     DEPLOY_KEY: ${{secrets.DEPLOY_KEY_DOCS}}
-      #   with:
-      #     flags: '-avzr --delete'
-      #     options: ''
-      #     ssh_options: '-p ${{secrets.DEPLOY_PORT}}'
-      #     src: '_build/html/'
-      #     dest: '${{secrets.DEPLOY_USER_DOCS}}@${{secrets.DEPLOY_SERVER_DOCS}}:${{secrets.DEPLOY_PATH_DOCS}}'
-      - name: Commit documentation changes
+      # Deploy stable documentation (main branch)
+      - name: Deploy stable documentation
         if: github.ref == 'refs/heads/main'
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: _build/html
-      - name: Display status from deploy
-        if: github.ref == 'refs/heads/main'
-        run: echo "${{ steps.deploy.outputs.status }}"
+          keep_files: true  # Don't delete preview versions
+
+      # Deploy preview documentation (non-main branches)
+      - name: Deploy preview documentation
+        if: github.ref != 'refs/heads/main'
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: _build/html
+          destination_dir: previews/${{ steps.branch.outputs.safe }}
+          keep_files: true  # Don't delete other versions
+
+      - name: Display deployment status
+        run: |
+          if [ "${{ github.ref }}" == "refs/heads/main" ]; then
+            echo "✅ Deployed stable documentation to https://docs.openspp.org/"
+          else
+            BRANCH_SAFE=$(echo ${GITHUB_REF_NAME} | sed 's/\//-/g')
+            echo "✅ Deployed preview documentation to https://docs.openspp.org/previews/${BRANCH_SAFE}/"
+          fi