rgex/scripts/github-actions-info.ts

A powerful, chainable regex builder platform with comprehensive validation utilities

#!/usr/bin/env tsx

/**
 * GitHub Actions & GitHub Pages Setup Information
 *
 * This script provides information about the GitHub Actions workflows
 * and how to set up GitHub Pages for automatic documentation deployment.
 */

console.log('🚀 GitHub Actions & Pages Setup Guide');
console.log('======================================\n');

console.log('📋 Available Workflows:');
console.log('========================');
console.log('1. 📖 Documentation Deployment (.github/workflows/docs.yml)');
console.log('   - Triggers: Push/PR to main branch');
console.log('   - Actions: Build docs → Deploy to GitHub Pages');
console.log('   - Output: Live documentation site\n');

console.log('2. 🔄 Continuous Integration (.github/workflows/ci.yml)');
console.log('   - Triggers: Push/PR to main/develop, Releases');
console.log('   - Actions: Test → Build → Publish (on release)');
console.log('   - Matrix: Node 18/20, Ubuntu/Windows/macOS\n');

console.log('⚙️ GitHub Pages Setup:');
console.log('=======================');
console.log('1. Go to your GitHub repository');
console.log('2. Navigate to Settings → Pages');
console.log('3. Source: "GitHub Actions"');
console.log('4. The docs.yml workflow will handle deployment\n');

console.log('🔑 Required Secrets (for CI/CD):');
console.log('=================================');
console.log('• NPM_TOKEN - For publishing to NPM registry');
console.log('• GITHUB_TOKEN - Automatically provided by GitHub\n');

console.log('📦 What Gets Built:');
console.log('===================');
console.log('✅ TypeScript compilation');
console.log('✅ Type declarations (.d.ts)');
console.log('✅ Comprehensive documentation');
console.log('✅ Test execution (148+ tests)');
console.log('✅ Cross-platform compatibility\n');

console.log('🌐 Documentation Features:');
console.log('===========================');
console.log('• 📖 Complete API reference');
console.log('• 🔍 Searchable interface');
console.log('• 🎨 Custom styling & branding');
console.log('• 📱 Mobile-responsive design');
console.log('• 🔗 Source code links');
console.log('• 📊 Type information & examples\n');

console.log('🎯 Workflow Triggers:');
console.log('======================');
console.log('Documentation Build:');
console.log('├── Push to main → Build & deploy docs');
console.log('├── Pull Request → Build docs (preview)');
console.log('└── Manual trigger → Force rebuild\n');

console.log('CI/CD Pipeline:');
console.log('├── Push/PR → Run tests & build');
console.log('├── Release → Publish to NPM');
console.log('└── Tag → Create GitHub release\n');

console.log('📊 Build Artifacts:');
console.log('===================');
console.log('• dist/ - Compiled JavaScript & types');
console.log('• docs/ - Generated documentation');
console.log('• Coverage reports');
console.log('• Release archives\n');

console.log('🔧 Local Testing:');
console.log('==================');
console.log('Test documentation build:');
console.log('  bun run pages:build');
console.log('  bun run pages:test\n');

console.log('Test CI pipeline locally:');
console.log('  bun run build:ci\n');

console.log('Preview documentation:');
console.log('  bun run docs:preview\n');

console.log('✨ Benefits:');
console.log('============');
console.log('🚀 Automatic deployment on every push');
console.log('📚 Always up-to-date documentation');
console.log('🔄 Continuous integration & testing');
console.log('📦 Automated NPM publishing');
console.log('🌍 Global CDN delivery via GitHub Pages');
console.log('📱 Mobile-friendly documentation');
console.log('🔍 SEO-optimized pages');

console.log('\n🎉 Setup Complete!');
console.log('==================');
console.log('Your documentation will be available at:');
console.log('\nExample: https://duongnguyen321.github.io/rgex/');