Files
k8s-game-2048/docs/WORKFLOW_QUICK_REFERENCE.md
Greg 82fc2a6691 feat: Complete PII cleanup and fully automatic pipeline
🧹 PII Cleanup & Security:
- Remove all hardcoded domains (darknex.us, hndrx.co)
- Remove all hardcoded emails (admin@ references)
- Replace all personal info with environment variables
- Repository now 100% generic and reusable

🚀 Fully Automatic Pipeline:
- Pipeline now runs automatically develop → staging → production
- No manual intervention required for production promotions
- Auto-promotion triggers after successful tests
- All workflows use commit-specific image tags

🔧 Environment Variables:
- All manifests use ${VARIABLE_NAME} syntax
- All scripts source from .env file
- GitHub Actions use secrets for sensitive data
- Complete .env.example template provided

📚 Documentation:
- New comprehensive WORKFLOWS.md with pipeline details
- New PIPELINE_QUICK_REFERENCE.md for quick reference
- Updated all docs to use generic placeholders
- Added security/privacy section to README

🔐 Security Enhancements:
- Updated .gitignore for all sensitive files
- Created PII verification script (verify-pii-removal.sh)
- Created cleanup automation script (cleanup-pii.sh)
- Repository verified PII-free and production-ready

BREAKING: Repository now requires .env configuration
- Copy .env.example to .env and configure for your environment
- Set GitHub repository secrets for CI/CD workflows
- All deployments now use environment-specific configuration
2025-07-01 17:30:26 -07:00

2.5 KiB

🚀 Quick Workflow Reference

🎯 Common Actions

Check All Environment Status

Actions → Deployment Status Check → Run workflow

Manual Production Deployment

Actions → Deploy to Production → Run workflow
↳ Type "DEPLOY" in confirmation
↳ Optional: specify image tag

Manual Production Promotion

Actions → Promote to Production → Run workflow  
↳ Type "PROMOTE" in confirmation
↳ Optional: skip tests if staging validated

Test Specific Environment

Actions → Smoke Tests → Run workflow
↳ Select environment (dev/staging/prod/all)

🔄 Automatic Flow

develop → build → deploy-dev → test → promote → staging → build → deploy-staging → test → promote → main → deploy-prod

📋 Workflow Quick Reference

Workflow Trigger Purpose Manual?
Build and Push Container Image Push to branches Build Docker images
Deploy to Development After build on develop Deploy to dev environment
Smoke Tests After deployments Test deployed environments
Auto-Promote Pipeline After dev smoke tests pass Merge develop → staging
Deploy to Staging Push to staging Deploy to staging environment
Promote to Production After staging smoke tests Merge staging → main
Deploy to Production Push to main OR manual Deploy to production
Deployment Status Check Manual or scheduled Check all environment health

🎮 Environment URLs

  • Dev: Your configured development domain
  • Staging: Your configured staging domain
  • Production: Your configured production domain

🏷️ Image Tags

  • Development: develop-{commit} (e.g., develop-abc1234)
  • Staging: staging-{commit} (e.g., staging-def5678)
  • Production: main-{commit} (e.g., main-ghi9012)

🔑 Required Confirmations

  • Deploy to Production: Type DEPLOY
  • Promote to Production: Type PROMOTE

🆘 Emergency Commands

Rollback Production

  1. Actions → Deploy to Production
  2. Specify last known good image tag
  3. Type "DEPLOY"

Force Promotion (Skip Tests)

  1. Actions → Promote to Production
  2. Type "PROMOTE"
  3. Enable "Skip tests" checkbox

Check System Health

  1. Actions → Deployment Status Check
  2. View summary for all environment status

💡 Tip: Always check "Deployment Status Check" first to see current state of all environments!