🔄 Preview: add release 5.5

.github/test-events/issue_comment.json

@@ -0,0 +1,26 @@
+{
+  "action": "created",
+  "issue": {
+    "number": 234,
+    "pull_request": {
+      "url": "https://api.github.com/repos/TykTechnologies/tyk-docs/pulls/234"
+    }
+  },
+  "comment": {
+    "body": "/release to release-5.8",
+    "user": {
+      "login": "test-user"
+    }
+  },
+  "repository": {
+    "name": "mintlify-poc",
+    "full_name": "TykTechnologies/mintlify-poc",
+    "default_branch": "main",
+    "owner": {
+      "login": "TykTechnologies"
+    }
+  },
+  "sender": {
+    "login": "test-user"
+  }
+}

.github/workflows/deploy-docs.yml

@@ -1,14 +1,19 @@
 name: Deploy Documentation
 
 on:
-  workflow_dispatch:  # Manual trigger only
+  workflow_dispatch:
     inputs:
       subfolder:
-        description: 'Subfolder for documentation (e.g., docs3, docsv3, docs)'
+        description: 'Subfolder for documentation (leave empty for root deployment)'
         required: false
-        default: 'docs3'
+        default: ''
         type: string
 
+# Ensure only latest deployment runs
+concurrency:
+  group: docs-deployment
+  cancel-in-progress: true
+
 jobs:
   merge-docs:
     runs-on: ubuntu-latest
@@ -43,77 +48,68 @@ jobs:
 
       - name: Cleanup old version folders and assets
         run: |
-          echo "🧹 Cleaning up old version folders and assets..."
-
-          # Get current version folders from config
-          current_folders=$(python3 -c "import json; config=json.load(open('branches-config.json')); folders=[v.get('folder','') for v in config.get('versions',[]) if v.get('folder','')]; print(' '.join(folders))")
-
-          echo "📋 Current version folders: $current_folders"
-
-          # Define asset types that will be regenerated
-          asset_types=(
-            "style.css"
-            "images"
-            "img" 
-            "logo"
-            "favicon.ico"
-            "favicon.png"
-            "snippets"
+          echo "🧹 Cleaning up all content except essential files..."
+
+          # Define folders to keep (whitelist)
+          keep_folders=(
+            ".github"
+            ".git" 
+            ".devcontainer"
+            "scripts"
+            ".vale"
           )
 
-          # Remove old assets (they'll be regenerated from current versions)
-          echo "🎨 Cleaning up old assets..."
-          for asset in "${asset_types[@]}"; do
-            if [ -e "$asset" ]; then
-              echo "🗑️  Removing old asset: $asset"
-              rm -rf "$asset"
-            fi
-          done
-
-          # Remove old docs.json (will be regenerated)
-          if [ -f "docs.json" ]; then
-            echo "🗑️  Removing old docs.json"
-            rm -f "docs.json"
-          fi
+          # Define files to keep (whitelist)
+          keep_files=(
+            "branches-config.json"
+            ".gitignore" 
+            "README.md"
+            ".vale.ini"
+          )
 
-          # Also clean up the subfolder if it exists (using input parameter)
-          SUBFOLDER="${{ inputs.subfolder || 'docs3' }}"
-          if [ -n "$SUBFOLDER" ] && [ -d "$SUBFOLDER" ]; then
-            echo "🗑️  Removing old $SUBFOLDER subfolder"
-            rm -rf "$SUBFOLDER"
-          fi
+          echo "📋 Folders to keep: ${keep_folders[*]}"
+          echo "📋 Files to keep: ${keep_files[*]}"
 
-          # Remove old version folders that aren't in the current config
-          # Look for directories that look like version folders (numeric or version-like names)
+          # Remove all directories except the ones we want to keep
+          echo "🗑️  Removing old directories..."
           for dir in */; do
             if [ -d "$dir" ]; then
               dir_name=${dir%/}  # Remove trailing slash
-
-              # Skip non-version directories
-              if [[ "$dir_name" =~ ^\..*$ ]] || [ "$dir_name" = ".github" ]; then
-                continue
-              fi
-
-              # Check if this folder is in current config
-              is_current=false
-              for current in $current_folders; do
-                if [ "$dir_name" = "$current" ]; then
-                  is_current=true
+
+              should_keep=false
+              for keep_folder in "${keep_folders[@]}"; do
+                if [ "$dir_name" = "$keep_folder" ]; then
+                  should_keep=true
                   break
                 fi
               done
+
+              if [ "$should_keep" = false ]; then
+                echo "🗑️  Removing directory: $dir_name/"
+                rm -rf "$dir"
+              else
+                echo "📁 Keeping essential directory: $dir_name/"
+              fi
+            fi
+          done
 
-              # If it's not in current config and looks like a version folder, remove it
-              if [ "$is_current" = false ]; then
-                # Only remove if it looks like a version folder (contains numbers/dots or common version patterns)
-                if [[ "$dir_name" =~ ^[0-9]+\.[0-9]+$ ]] || [[ "$dir_name" =~ ^v[0-9] ]] || [[ "$dir_name" =~ ^[0-9] ]]; then
-                  echo "🗑️  Removing old version folder: $dir_name"
-                  rm -rf "$dir"
-                else
-                  echo "📁 Keeping non-version directory: $dir_name"
+          # Remove all files except the ones we want to keep
+          echo "🗑️  Removing old files..."
+          for file in *; do
+            if [ -f "$file" ]; then
+              should_keep=false
+              for keep_file in "${keep_files[@]}"; do
+                if [ "$file" = "$keep_file" ]; then
+                  should_keep=true
+                  break
                 fi
+              done
+
+              if [ "$should_keep" = false ]; then
+                echo "🗑️  Removing file: $file"
+                rm -f "$file"
               else
-                echo "📁 Keeping current version folder: $dir_name (will be refreshed)"
+                echo "📄 Keeping essential file: $file"
               fi
             fi
           done
@@ -129,7 +125,7 @@ jobs:
           echo "🔄 Starting branch cloning and organization..."
 
           # Read the branches config and extract branch information
-          branches=$(python3 -c "import json; config=json.load(open('branches-config.json')); [print(f\"{v.get('folder','')}:{v.get('branch','main')}\") for v in config.get('versions',[]) if v.get('folder','')]")
+          branches=$(python3 -c "import json; config=json.load(open('branches-config.json')); [print(f\"{v.get('sourceFolder','')}:{v.get('branch','main')}\") for v in config.get('versions',[]) if v.get('sourceFolder','')]")
 
           echo "📋 Branches to process:"
           echo "$branches"
@@ -160,8 +156,17 @@ jobs:
               mkdir -p "$folder"
               echo "📁 Moving contents from $temp_dir to $folder..."
 
-              # Copy all files except .git directory
-              find "$temp_dir" -mindepth 1 -maxdepth 1 ! -name '.git' -exec cp -r {} "$folder/" \;
+              # Copy documentation content only, excluding development/build files
+              # Excluded: .git, scripts/, branches-config.json, .github/, README.md, .gitignore, .devcontainer/
+              find "$temp_dir" -mindepth 1 -maxdepth 1 \
+                ! -name '.git' \
+                ! -name 'scripts' \
+                ! -name 'branches-config.json' \
+                ! -name '.github' \
+                ! -name 'README.md' \
+                ! -name '.gitignore' \
+                ! -name '.devcontainer' \
+                -exec cp -r {} "$folder/" \;
 
               # Clean up temp directory
               rm -rf "$temp_dir"
@@ -180,19 +185,21 @@ jobs:
         run: |
           echo "🔄 Running documentation merger..."
 
-          # Get subfolder from input (with fallback)
-          SUBFOLDER="${{ inputs.subfolder || 'docs3' }}"
-          echo "📁 Using subfolder: $SUBFOLDER"
+          # Get subfolder from input (no fallback - empty means root deployment)
+          SUBFOLDER="${{ inputs.subfolder }}"
+          echo "📁 Using subfolder: '$SUBFOLDER'"
 
           # Run the merge script with branches config
           if [ -n "$SUBFOLDER" ]; then
-            python3 merge_docs_configs.py \
+            echo "📁 Deploying to subfolder: $SUBFOLDER"
+            python3 scripts/merge_docs_configs.py \
               --branches-config branches-config.json \
               --base-dir . \
               --subfolder "$SUBFOLDER" \
               --output docs.json
           else
-            python3 merge_docs_configs.py \
+            echo "📁 Deploying to root (no subfolder)"
+            python3 scripts/merge_docs_configs.py \
               --branches-config branches-config.json \
               --base-dir . \
               --output docs.json
@@ -205,7 +212,7 @@ jobs:
           echo "🧹 Cleaning up temporary cloned version folders..."
 
           # Get current version folders from config
-          current_folders=$(python3 -c "import json; config=json.load(open('branches-config.json')); folders=[v.get('folder','') for v in config.get('versions',[]) if v.get('folder','')]; print(' '.join(folders))")
+          current_folders=$(python3 -c "import json; config=json.load(open('branches-config.json')); folders=[v.get('sourceFolder','') for v in config.get('versions',[]) if v.get('sourceFolder','')]; print(' '.join(folders))")
 
           echo "📋 Removing cloned folders: $current_folders"
 
@@ -237,7 +244,38 @@ jobs:
           echo "📁 Generated file structure:"
           find . -name "*.mdx" -o -name "*.md" -o -name "*.json" -o -name "*.css" -o -name "*.png" | head -20
 
+      - name: Close previous deployment PRs
+        run: |
+          echo "🔍 Finding and closing previous deployment PRs..."
+
+          # Find PRs that match BOTH criteria:
+          # 1. Have the "auto-deployment" label
+          # 2. Branch starts with "docs-merge-"
+          DEPLOYMENT_PRS=$(gh pr list \
+            --state open \
+            --label "auto-deployment" \
+            --json number,headRefName,labels \
+            --jq '.[] | select(.headRefName | startswith("docs-merge-")) | .number')
+
+          if [ -n "$DEPLOYMENT_PRS" ]; then
+            echo "📋 Found deployment PRs to close: $DEPLOYMENT_PRS"
+
+            for pr_number in $DEPLOYMENT_PRS; do
+              echo "❌ Closing deployment PR #$pr_number"
+              gh pr close "$pr_number" \
+                --comment "🤖 Superseded by newer deployment (Run #${{ github.run_number }})" \
+                || echo "⚠️ Failed to close PR #$pr_number (may already be closed)"
+            done
+
+            echo "✅ Closed all previous deployment PRs"
+          else
+            echo "✅ No deployment PRs found to close"
+          fi
+        env:
+          GH_TOKEN: ${{ secrets.ORG_GH_TOKEN }}
+
       - name: Create Pull Request
+        id: create-pr
         uses: peter-evans/create-pull-request@v7
         with:
           token: ${{ secrets.ORG_GH_TOKEN }}
@@ -252,19 +290,23 @@ jobs:
             **Generated from:** `branches-config.json`  
             **Timestamp:** ${{ github.event.head_commit.timestamp }}  
             **Run ID:** ${{ github.run_id }}
+            **Subfolder:** `${{ inputs.subfolder || '(root deployment)' }}`
 
             ### Changes Include:
             - ✅ Merged documentation from multiple branches
             - ✅ Generated unified `docs.json` configuration
             - ✅ Updated assets and content structure
             - ✅ Cleaned up outdated version folders
 
-            ### Subfolder Used:
-            `${{ inputs.subfolder || 'docs3' }}`
-
             ---
 
-            Please review the changes and merge when ready.
+            🚦 **This PR will be processed by merge queue to ensure proper validation and ordering.**
+
+            Previous deployment PRs have been automatically closed to prevent conflicts.
+          labels: |
+            documentation
+            auto-deployment
+            automated
           commit-message: |
             🤖 Auto-merge documentation from branches
 
@@ -279,6 +321,18 @@ jobs:
           author: ${{ github.actor }} <${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com>
           committer: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
 
+      - name: Enable auto-merge on deployment PR
+        if: steps.create-pr.outputs.pull-request-number
+        run: |
+          PR_NUMBER="${{ steps.create-pr.outputs.pull-request-number }}"
+          echo "� Enabling auto-merge on deployment PR #$PR_NUMBER..."
+
+          gh pr merge --squash --auto "$PR_NUMBER"
+
+          echo "✅ Auto-merge enabled on PR #$PR_NUMBER"
+        env:
+          GH_TOKEN: ${{ secrets.ORG_GH_TOKEN }}
+
       - name: Create deployment summary
         run: |
           echo "## 📚 Documentation Deployment Summary" >> $GITHUB_STEP_SUMMARY
@@ -294,4 +348,4 @@ jobs:
           fi
 
           echo "" >> $GITHUB_STEP_SUMMARY
-          echo "**Timestamp:** $(date)" >> $GITHUB_STEP_SUMMARY
+          echo "**Timestamp:** $(date)" >> $GITHUB_STEP_SUMMARY