Skip to content

Fix deployment workflows and add robust fallback for missing deploy branch #548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
litlfred merged 4 commits into from
Aug 5, 2025
Merged

Fix deployment workflows and add robust fallback for missing deploy branch #548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5154219
Initial plan
Copilot Aug 5, 2025
010959d
Fix missing deployment structure - add sgex/ to .gitignore and verify…
Copilot Aug 5, 2025
87ee122
Refactor: Remove deployment files from main branch
Copilot Aug 5, 2025
98c8dec
Fix deployment workflows to preserve existing branch directories
Copilot Aug 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 85 additions & 44 deletions .github/workflows/landing-page-deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ on:
workflow_dispatch:
inputs:
source_branch:
description: 'Branch to use for build scripts (defaults to current branch)'
description: 'Branch to use for build scripts (defaults to deploy branch)'
required: false
default: ''
default: 'deploy'

permissions:
contents: write
Expand All @@ -28,9 +28,10 @@ jobs:
deploy-landing-page:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
- name: Checkout deploy branch (or fallback to main)
uses: actions/checkout@v4
with:
ref: main # Use main branch since deploy branch doesn't exist yet
fetch-depth: 0 # Fetch full history for gh-pages branch

- name: Configure git user
Expand All @@ -54,16 +55,55 @@ jobs:
set -e

echo "Building self-contained landing page..."
# Use current branch for build scripts unless specified
source_branch="${{ github.event.inputs.source_branch }}"
if [[ -z "$source_branch" ]]; then
source_branch="${{ github.ref_name }}"
fi

echo "Using build scripts from branch: $source_branch"

# Build the landing page with self-contained assets
node scripts/build-multi-branch.js landing
# Check if we have landing page assets from deploy branch
if [[ -f "public/branch-listing.html" ]]; then
echo "Using landing page assets from deploy branch..."
npm run build:landing
else
echo "Deploy branch assets not available, creating basic landing page..."

# Create a minimal landing page build
mkdir -p build

cat > build/index.html << 'EOF'
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>SGEX Workbench</title>
<style>
body { font-family: Arial, sans-serif; margin: 40px; }
.container { max-width: 800px; margin: 0 auto; }
.section { margin: 20px 0; padding: 20px; border: 1px solid #ddd; border-radius: 8px; }
</style>
</head>
<body>
<div class="container">
<h1>🚀 SGEX Workbench</h1>
<p>WHO SMART Guidelines Exchange</p>

<div class="section">
<h2>🌟 Main Application</h2>
<p><a href="./main/">Launch SGEX Workbench (Main Branch)</a></p>
</div>

<div class="section">
<h2>📝 Branch & PR Previews</h2>
<p>Branch and pull request previews are automatically deployed to subdirectories.</p>
<p>Each branch is accessible at <code>/branch-name/</code></p>
</div>

<div class="section">
<h2>ℹ️ About</h2>
<p>SGEX is an experimental collaborative project developing a workbench of tools to make it easier and faster to develop high fidelity SMART Guidelines Digital Adaptation Kits (DAKs).</p>
</div>
</div>
</body>
</html>
EOF
fi

# Verify index.html exists
if [[ ! -f "build/index.html" ]]; then
Expand All @@ -73,7 +113,7 @@ jobs:

echo "✅ Landing page build completed"

- name: Deploy to gh-pages root
- name: Deploy to gh-pages root (preserving existing branches)
shell: bash
run: |
set -e
Expand All @@ -99,43 +139,43 @@ jobs:
git push origin gh-pages
fi

# Preserve all existing branch directories (exclude problematic cache directories)
echo "Preserving existing branch directories..."
if ls -d */ > /dev/null 2>&1; then
mkdir -p /tmp/branch-backup
for dir in */; do
if [[ "$dir" != "node_modules/" && "$dir" != ".cache/" ]]; then
echo "Backing up directory: $dir"
# Exclude cache subdirectories when copying
rsync -av --exclude='*/node_modules/.cache' --exclude='*/.cache' "$dir" /tmp/branch-backup/
fi
done
# CRITICAL: Only remove files, NEVER remove directories (to preserve branch builds)
echo "Removing only root-level files (preserving all branch directories)..."

# List what directories exist for safety verification
echo "Existing directories before cleanup:"
ls -la */ 2>/dev/null || echo "No directories found"

# Remove only specific files that could conflict with landing page
rm -f index.html
rm -f manifest.json
rm -f asset-manifest.json
rm -f service-worker.js
rm -f robots.txt
rm -f favicon.ico
rm -f logo*.png
rm -f README.md
rm -f package.json
rm -f package-lock.json

# Remove static directory only if it exists at root (not in branch subdirs)
if [[ -d "static" ]]; then
echo "Removing root static directory..."
rm -rf static
fi

# Clear root (except .git and branch directories)
echo "Clearing root directory for landing page deployment..."
find . -maxdepth 1 -not -name '.' -not -name '.git' -not -name '.github' -exec rm -rf {} +

# Also clean up any cache directories that might exist
echo "Cleaning up cache directories..."
find . -name "node_modules/.cache" -type d -exec rm -rf {} + 2>/dev/null || true
find . -name ".cache" -type d -exec rm -rf {} + 2>/dev/null || true

# Deploy landing page to root
# Deploy landing page to root (this will not affect any subdirectories)
echo "Deploying landing page to root..."
cp -a /tmp/landing-build/. .

# Restore all branch directories
if [[ -d /tmp/branch-backup ]]; then
echo "Restoring branch directories..."
cp -r /tmp/branch-backup/* .
rm -rf /tmp/branch-backup
fi
# Verify existing directories are still there
echo "Directories after deployment:"
ls -la */ 2>/dev/null || echo "No directories found"

# Clean up temporary build
rm -rf /tmp/landing-build

echo "✅ Landing page deployed to gh-pages root"
echo "✅ Landing page deployed to gh-pages root while preserving all branch directories"

- name: Commit and push changes
shell: bash
Expand All @@ -161,15 +201,15 @@ jobs:
# Determine deployment type for commit message
if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
deployment_type="manual"
trigger_info="Triggered from branch: ${{ github.ref_name }}"
trigger_info="Triggered from deploy branch"
else
deployment_type="automatic"
trigger_info="Auto-triggered by push to main"
fi

git commit -m "🏠 Deploy landing page (${deployment_type})

- Updated landing page with self-contained assets
- Updated landing page with self-contained assets from deploy branch
- ${trigger_info}
- Deployed at $(date -u '+%Y-%m-%d %H:%M:%S UTC')
- Commit: ${{ github.sha }}"
Expand All @@ -189,7 +229,7 @@ jobs:
# Determine deployment type for output message
if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
deployment_type="Manual"
trigger_info="Triggered from branch: ${{ github.ref_name }}"
trigger_info="Triggered from deploy branch"
else
deployment_type="Automatic"
trigger_info="Auto-triggered by push to main"
Expand All @@ -200,4 +240,5 @@ jobs:
echo "- Deployment Type: $deployment_type"
echo "- $trigger_info"
echo "- Deployed at: $(date -u '+%Y-%m-%d %H:%M:%S UTC')"
echo "- Source Branch: ${{ github.event.inputs.source_branch || 'deploy' }}"
echo "- Commit: ${{ github.sha }}"
56 changes: 54 additions & 2 deletions .github/workflows/pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,44 @@ jobs:
export BASE_PATH="/${safe_branch_name}/"
fi
echo "Building with BASE_PATH: $BASE_PATH"

# Get build script from deploy branch (fallback to local if deploy branch doesn't exist)
echo "Fetching build script from deploy branch..."
if git fetch origin deploy 2>/dev/null; then
echo "Deploy branch found, using build script from deploy branch"
git checkout origin/deploy -- scripts/build-multi-branch.js
else
echo "Deploy branch not found, checking if build script exists locally..."
if [[ ! -f "scripts/build-multi-branch.js" ]]; then
echo "ERROR: Build script not found and deploy branch doesn't exist"
echo "Creating minimal build script as fallback..."
mkdir -p scripts
cat > scripts/build-multi-branch.js << 'EOF'
const { execSync } = require('child_process');
const fs = require('fs');
const path = require('path');

console.log('Building React app for deployment...');

// Simplified build process
try {
// Set environment variables
process.env.NODE_ENV = 'production';
process.env.PUBLIC_URL = process.env.BASE_PATH || '/';

// Run the build
execSync('npm run build', { stdio: 'inherit' });

console.log('✅ Build completed successfully');
} catch (error) {
console.error('❌ Build failed:', error.message);
process.exit(1);
}
EOF
fi
fi

# Run the build script
node scripts/build-multi-branch.js branch
env:
CI: false
Expand Down Expand Up @@ -224,21 +262,35 @@ jobs:

branch_dir="${{ steps.validate_branch.outputs.branch_dir }}"
repo_root="$(pwd)"
target_subdir="${{ steps.validate_branch.outputs.target_subdir }}"

echo "Cleaning old deployment"
echo "Branch directory: $branch_dir"
echo "Repository root: $repo_root"
echo "Target subdirectory: $target_subdir"

# Validate before any destructive operations
if [[ "$branch_dir" != "$repo_root"* ]] || [[ ${#branch_dir} -le ${#repo_root} ]]; then
echo "ERROR: Safety validation failed during cleanup"
exit 1
fi

# Use git to safely remove the branch directory
# Additional safety: ensure we're only removing the specific branch directory
if [[ "$target_subdir" == "." || "$target_subdir" == ".." || -z "$target_subdir" ]]; then
echo "ERROR: Invalid target subdirectory: '$target_subdir'"
exit 1
fi

# Use git to safely remove the specific branch directory only
if [[ -d "$branch_dir" ]]; then
echo "Removing existing deployment: $branch_dir"
git rm -rf "$branch_dir" || echo "Directory didn't exist in git"
# Additional safety: only remove if it matches our expected pattern
if [[ "$branch_dir" == "$repo_root/$target_subdir" ]]; then
git rm -rf "$target_subdir" 2>/dev/null || echo "Directory didn't exist in git"
else
echo "ERROR: Branch directory path doesn't match expected pattern"
exit 1
fi
else
echo "No existing deployment to clean"
fi
Expand Down
5 changes: 4 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,7 @@ temp_serve/
# Generated QA reports (auto-generated by CI, should not be committed)
docs/qa-report.html
public/docs/qa-report.html
docs/github-issues-analysis.md
docs/github-issues-analysis.md

# Deployment structure (generated by CI/CD)
sgex/
1 change: 0 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
"scripts": {
"start": "craco start",
"build": "react-scripts build",
"build:multi-branch": "node scripts/build-multi-branch.js",
"test": "react-scripts test",
"eject": "react-scripts eject",
"serve": "npm run build && cd build && python3 -m http.server 3000",
Expand Down
Loading