deploy-docs.yml

name: Deploy Documentation

on:
  workflow_dispatch:
    inputs:
      subfolder:
        description: 'Subfolder for documentation (leave empty for root deployment)'
        required: false
        default: ''
        type: string
      triggering_pr_number:
        description: 'PR number that triggered this deployment'
        required: false
        default: ''
        type: string
      triggering_pr_title:
        description: 'PR title that triggered this deployment'
        required: false
        default: ''
        type: string
      triggering_commit_sha:
        description: 'Commit SHA that triggered this deployment'
        required: false
        default: ''
        type: string
      triggering_branch:
        description: 'Branch that triggered this deployment'
        required: false
        default: ''
        type: string
      original_pr_number:
        description: 'Original PR number (if different from triggering PR)'
        required: false
        default: ''
        type: string

permissions:
  contents: write
  pull-requests: write

# Ensure only latest deployment runs
concurrency:
  group: docs-deployment
  cancel-in-progress: true

jobs:
  merge-docs:
    runs-on: ubuntu-latest

    steps:
      - name: Generate GitHub App token
        id: app-token
        uses: actions/create-github-app-token@d72941d797fd3113feb6b93fd0dec494b13a2547 # v1
        with:
          app-id: ${{ secrets.PROBE_APP_ID }}
          private-key: ${{ secrets.PROBE_APP_PRIVATE_KEY }}
          owner: TykTechnologies

      - name: Log deployment trigger information
        run: |
          echo "🚀 Starting documentation deployment"
          echo "📋 Trigger Information:"
          echo "  - Branch: ${{ inputs.triggering_branch || 'N/A' }}"
          echo "  - Commit: ${{ inputs.triggering_commit_sha || 'N/A' }}"
          if [ -n "${{ inputs.triggering_pr_number }}" ]; then
            echo "  - PR: #${{ inputs.triggering_pr_number }} - ${{ inputs.triggering_pr_title }}"
            if [ -n "${{ inputs.original_pr_number }}" ] && [ "${{ inputs.original_pr_number }}" != "${{ inputs.triggering_pr_number }}" ]; then
              echo "  - Original PR: #${{ inputs.original_pr_number }} (cherry-picked)"
            fi
          else
            echo "  - PR: N/A (direct push)"
          fi
          echo "  - Timestamp: $(date)"
          echo "  - Workflow Run: ${{ github.run_id }}"
          echo "  - Subfolder: ${{ inputs.subfolder || '(root deployment)' }}"

      - name: Checkout production branch
        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5  # v4
        with:
          ref: production
          token: ${{ steps.app-token.outputs.token }}
          fetch-depth: 0  # Fetch all history for all branches

      - name: Set up Python
        uses: actions/setup-python@7f4fc3e22c37d6ff65e88745f38bd3157c663f7c  # v4
        with:
          python-version: '3.9'

      - name: Install dependencies
        run: |
          python -m pip install --upgrade 'pip>=23.0,<25'
          # Add any additional dependencies if needed

      - name: Read branches config
        id: config
        run: |
          if [ ! -f "branches-config.json" ]; then
            echo "❌ branches-config.json not found!"
            exit 1
          fi
          echo "✅ Found branches-config.json"
          cat branches-config.json

      - name: Cleanup old version folders and assets
        run: |
          echo "🧹 Cleaning up all content except essential files..."
          
          # Define folders to keep (whitelist)
          keep_folders=(
            ".github"
            ".git" 
            ".devcontainer"
            "scripts"
            ".vale"
            ".probe"
          )
          
          # Define files to keep (whitelist)
          keep_files=(
            "branches-config.json"
            ".gitignore" 
            "README.md"
            ".vale.ini"
          )
          
          echo "📋 Folders to keep: ${keep_folders[*]}"
          echo "📋 Files to keep: ${keep_files[*]}"
          
          # 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
              
              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
          
          # 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 essential file: $file"
              fi
            fi
          done
          
          echo "✅ Cleanup completed!"
          echo "📁 Remaining files after cleanup:"
          ls -la | grep -E "^[d-]" | head -10

      - name: Clone and organize branches
        run: |
          set -e
          
          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('sourceFolder','')}:{v.get('branch','main')}\") for v in config.get('versions',[]) if v.get('sourceFolder','')]")
          
          echo "📋 Branches to process:"
          echo "$branches"
          
          # Clone each branch into its respective folder
          for branch_info in $branches; do
            if [ -n "$branch_info" ]; then
              folder=$(echo $branch_info | cut -d':' -f1)
              branch=$(echo $branch_info | cut -d':' -f2)
          
              echo "📂 Processing $folder from branch $branch..."
          
              # Remove existing folder if it exists
              if [ -d "$folder" ]; then
                echo "🗑️  Removing existing $folder/"
                rm -rf "$folder"
              fi
          
              # Create temporary directory for this branch
              temp_dir="temp_$folder"
          
              # Clone the specific branch
              echo "⬇️  Cloning branch $branch into $temp_dir..."
              git clone --single-branch --branch "$branch" --depth 1 \
                "https://github.com/${{ github.repository }}.git" "$temp_dir"
          
              # Move the contents (excluding .git) to the target folder
              mkdir -p "$folder"
              echo "📁 Moving contents from $temp_dir to $folder..."
          
              # Copy documentation content only, excluding development/build files
              # Excluded: .git, scripts/, branches-config.json, .github/, README.md, .gitignore, .devcontainer/, .probe
              find "$temp_dir" -mindepth 1 -maxdepth 1 \
                ! -name '.git' \
                ! -name 'scripts' \
                ! -name 'branches-config.json' \
                ! -name '.github' \
                ! -name 'README.md' \
                ! -name '.gitignore' \
                ! -name '.devcontainer' \
                ! -name '.probe' \
                -exec cp -r {} "$folder/" \;
          
              # Clean up temp directory
              rm -rf "$temp_dir"
          
              echo "✅ Successfully organized $folder from branch $branch"
          
              # Show what was copied
              echo "📋 Contents of $folder:"
              ls -la "$folder/" | head -10
            fi
          done
          
          echo "🎉 All branches cloned and organized!"

      - name: Run docs merger
        run: |
          echo "🔄 Running documentation merger..."
          
          # 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
            echo "📁 Deploying to subfolder: $SUBFOLDER"
            python3 scripts/merge_docs_configs.py \
              --branches-config branches-config.json \
              --base-dir . \
              --subfolder "$SUBFOLDER" \
              --output docs.json
          else
            echo "📁 Deploying to root (no subfolder)"
            python3 scripts/merge_docs_configs.py \
              --branches-config branches-config.json \
              --base-dir . \
              --output docs.json
          fi
          
          echo "✅ Documentation merge completed!"

      - name: Cleanup cloned version folders
        run: |
          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('sourceFolder','') for v in config.get('versions',[]) if v.get('sourceFolder','')]; print(' '.join(folders))")
          
          echo "📋 Removing cloned folders: $current_folders"
          
          # Remove the temporary cloned folders (they've been processed into subfolder structure)
          for folder in $current_folders; do
            if [ -n "$folder" ] && [ -d "$folder" ]; then
              echo "🗑️  Removing cloned folder: $folder/"
              rm -rf "$folder"
            fi
          done
          
          echo "✅ Cleanup of cloned folders completed!"

      - name: Add canonical URLs to MDX files
        run: |
          echo "🧩 Running canonical URL update script..."
          python3 scripts/add-canonical-urls/index.py || { echo "❌ Canonical script failed"; exit 1; }
          echo "✅ Canonical URL update completed."

      - name: Verify output
        run: |
          echo "📋 Checking generated files..."
          
          if [ -f "docs.json" ]; then
            echo "✅ docs.json generated successfully"
            echo "📄 docs.json size: $(wc -c < docs.json) bytes"
            echo "🔍 First few lines of docs.json:"
            head -20 docs.json
          else
            echo "❌ docs.json not found!"
            exit 1
          fi
          
          echo ""
          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: ${{ steps.app-token.outputs.token }}

      - name: Create Pull Request
        id: create-pr
        uses: peter-evans/create-pull-request@22a9089034f40e5a961c8808d113e2c98fb63676  # v7
        with:
          token: ${{ steps.app-token.outputs.token }}
          branch: docs-merge-${{ github.run_number }}
          base: production
          title: "🤖 Auto-merge documentation from branches"
          body: |
            ## 📚 Documentation Merge Summary
            
            This PR contains automatically merged documentation from multiple branches.
            
            **Triggered by:**
            - **Branch:** ${{ inputs.triggering_branch || 'N/A' }}
            - **Commit:** ${{ inputs.triggering_commit_sha || 'N/A' }}
            - **PR:** ${{ inputs.triggering_pr_number && format('#{0} - {1}', inputs.triggering_pr_number, inputs.triggering_pr_title) || 'N/A (direct push)' }}${{ inputs.original_pr_number && inputs.original_pr_number != inputs.triggering_pr_number && format(' (cherry-pick of #{0})', inputs.original_pr_number) || '' }}
            
            **Deployment Details:**
            - **Generated from:** `branches-config.json`  
            - **Run ID:** ${{ github.run_id }}
            - **Subfolder:** `${{ inputs.subfolder || '(root deployment)' }}`
            - **Timestamp:** $(date)
            
            ### Changes Include:
            - ✅ Merged documentation from multiple branches
            - ✅ Generated unified `docs.json` configuration
            - ✅ Updated assets and content structure
            - ✅ Cleaned up outdated version folders
            
            ---
            
            🚦 **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
            
            Generated from branches-config.json at ${{ github.event.head_commit.timestamp }}
            
            - Merged documentation from multiple branches
            - Generated unified docs.json
            - Updated assets and content structure
          delete-branch: true
          draft: false
          maintainer-can-modify: true
          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: ${{ steps.app-token.outputs.token }}

      - name: Create deployment summary
        run: |
          echo "## 📚 Documentation Deployment Summary" >> $GITHUB_STEP_SUMMARY
          echo "" >> $GITHUB_STEP_SUMMARY
          echo "### 🚀 Trigger Information" >> $GITHUB_STEP_SUMMARY
          echo "- **Branch:** ${{ inputs.triggering_branch || 'N/A' }}" >> $GITHUB_STEP_SUMMARY
          echo "- **Commit:** ${{ inputs.triggering_commit_sha || 'N/A' }}" >> $GITHUB_STEP_SUMMARY
          if [ -n "${{ inputs.triggering_pr_number }}" ]; then
            echo "- **PR:** #${{ inputs.triggering_pr_number }} - ${{ inputs.triggering_pr_title }}" >> $GITHUB_STEP_SUMMARY
            if [ -n "${{ inputs.original_pr_number }}" ] && [ "${{ inputs.original_pr_number }}" != "${{ inputs.triggering_pr_number }}" ]; then
              echo "- **Original PR:** #${{ inputs.original_pr_number }} (cherry-picked)" >> $GITHUB_STEP_SUMMARY
            fi
          else
            echo "- **PR:** N/A (direct push)" >> $GITHUB_STEP_SUMMARY
          fi
          echo "" >> $GITHUB_STEP_SUMMARY
          echo "### ✅ Successfully merged documentation" >> $GITHUB_STEP_SUMMARY
          echo "" >> $GITHUB_STEP_SUMMARY
          echo "**Generated files:**" >> $GITHUB_STEP_SUMMARY
          echo "- \`docs.json\` - Unified configuration" >> $GITHUB_STEP_SUMMARY
          
          if [ -f "docs.json" ]; then
            echo "- Asset files (favicon.png, style.css, images/, etc.)" >> $GITHUB_STEP_SUMMARY
            echo "- Version folders with documentation content" >> $GITHUB_STEP_SUMMARY
          fi
          
          echo "" >> $GITHUB_STEP_SUMMARY
          echo "**Timestamp:** $(date)" >> $GITHUB_STEP_SUMMARY