|
| 1 | +#!/bin/bash |
| 2 | + |
| 3 | +# Demo script for github-action-base-ts - TypeScript GitHub Action template |
| 4 | + |
| 5 | +set -e |
| 6 | + |
| 7 | +echo "==========================================" |
| 8 | +echo " 🚀 GitHub Action Base (TypeScript)" |
| 9 | +echo " Production-Ready Action Template" |
| 10 | +echo "==========================================" |
| 11 | +echo "" |
| 12 | + |
| 13 | +echo "📦 Project Structure:" |
| 14 | +if [ -f "package.json" ]; then |
| 15 | + echo " ✅ TypeScript project detected" |
| 16 | + echo " • Jest for testing" |
| 17 | + echo " • ESLint + Prettier for code quality" |
| 18 | + echo " • Husky for git hooks" |
| 19 | + echo " • GitHub Actions CI/CD" |
| 20 | +else |
| 21 | + echo " ❌ package.json not found" |
| 22 | +fi |
| 23 | + |
| 24 | +echo "" |
| 25 | +echo "✨ Template Features:" |
| 26 | +echo "" |
| 27 | +echo " 🔧 Development Tools" |
| 28 | +echo " • TypeScript with strict mode" |
| 29 | +echo " • Jest test framework" |
| 30 | +echo " • ESLint + Prettier configured" |
| 31 | +echo " • Pre-commit hooks with Husky" |
| 32 | +echo " • Hot reload for development" |
| 33 | +echo "" |
| 34 | +echo " 🎯 GitHub Actions Integration" |
| 35 | +echo " • action.yml metadata configured" |
| 36 | +echo " • Inputs/outputs defined" |
| 37 | +echo " • Docker support included" |
| 38 | +echo " • CI/CD workflows ready" |
| 39 | +echo "" |
| 40 | +echo " 📊 Quality Assurance" |
| 41 | +echo " • 95%+ test coverage target" |
| 42 | +echo " • Automated linting" |
| 43 | +echo " • Type checking" |
| 44 | +echo " • Dependency scanning" |
| 45 | +echo "" |
| 46 | + |
| 47 | +echo "🧪 Running Tests..." |
| 48 | +if [ -d "node_modules" ]; then |
| 49 | + if [ -f "package.json" ]; then |
| 50 | + echo " Run: npm test" |
| 51 | + echo " Coverage: npm run test:coverage" |
| 52 | + fi |
| 53 | +else |
| 54 | + echo " ℹ️ Install dependencies: npm install" |
| 55 | +fi |
| 56 | + |
| 57 | +echo "" |
| 58 | +echo "📝 Usage Example:" |
| 59 | +echo "" |
| 60 | +echo " name: Use TypeScript Action" |
| 61 | +echo " on: [push]" |
| 62 | +echo " jobs:" |
| 63 | +echo " test:" |
| 64 | +echo " runs-on: ubuntu-latest" |
| 65 | +echo " steps:" |
| 66 | +echo " - uses: actions/checkout@v3" |
| 67 | +echo " - uses: wesleyscholl/github-action-base-ts@v1" |
| 68 | +echo " with:" |
| 69 | +echo " input-param: 'value'" |
| 70 | +echo "" |
| 71 | + |
| 72 | +echo "🛠️ Development Workflow:" |
| 73 | +echo "" |
| 74 | +echo " 1. Install dependencies:" |
| 75 | +echo " npm install" |
| 76 | +echo "" |
| 77 | +echo " 2. Run in development mode:" |
| 78 | +echo " npm run dev" |
| 79 | +echo "" |
| 80 | +echo " 3. Run tests:" |
| 81 | +echo " npm test" |
| 82 | +echo "" |
| 83 | +echo " 4. Build for production:" |
| 84 | +echo " npm run build" |
| 85 | +echo "" |
| 86 | +echo " 5. Package for release:" |
| 87 | +echo " npm run package" |
| 88 | +echo "" |
| 89 | + |
| 90 | +echo "📊 Template Benefits:" |
| 91 | +echo " • Faster action development (save hours)" |
| 92 | +echo " • Best practices built-in" |
| 93 | +echo " • Type safety with TypeScript" |
| 94 | +echo " • Automated testing & CI/CD" |
| 95 | +echo " • Production-ready from day 1" |
| 96 | +echo "" |
| 97 | + |
| 98 | +echo "==========================================" |
| 99 | +echo " Repository: github.com/wesleyscholl/github-action-base-ts" |
| 100 | +echo " Type: Template | Coverage: 95%+ target" |
| 101 | +echo "==========================================" |
| 102 | +echo "" |
0 commit comments