|
| 1 | +# GitHub Pages Deployment Fix Summary |
| 2 | + |
| 3 | +## Issue Description |
| 4 | +The GitHub Pages deployment workflow was failing with the error: |
| 5 | +``` |
| 6 | +tar: client/out: Cannot open: No such file or directory |
| 7 | +tar: Error is not recoverable: exiting now |
| 8 | +``` |
| 9 | + |
| 10 | +## Root Cause Analysis |
| 11 | + |
| 12 | +### Primary Issue: Environment Variable Mismatch |
| 13 | +- **Expected**: `DEPLOY_TARGET=github-pages` (in `next.config.ts` line 4) |
| 14 | +- **Actual**: `GITHUB_PAGES=true` (in `.github/workflows/nextjs.yml` line 116) |
| 15 | + |
| 16 | +The `next.config.ts` configuration checks for `process.env.DEPLOY_TARGET === 'github-pages'` to enable static export: |
| 17 | +```typescript |
| 18 | +const isGitHubPages = process.env.DEPLOY_TARGET === 'github-pages'; |
| 19 | +``` |
| 20 | + |
| 21 | +However, the GitHub Actions workflow was setting a different environment variable: |
| 22 | +```yaml |
| 23 | +env: |
| 24 | + GITHUB_PAGES: "true" # Wrong variable name |
| 25 | +``` |
| 26 | +
|
| 27 | +This caused the Next.js build to run in server mode (without static export), which doesn't create the `out` directory. The upload artifact step then failed trying to find `./client/out`. |
| 28 | + |
| 29 | +## Solution |
| 30 | + |
| 31 | +### Change Made |
| 32 | +Updated `.github/workflows/nextjs.yml` line 116: |
| 33 | +```yaml |
| 34 | +# Before: |
| 35 | +env: |
| 36 | + GITHUB_PAGES: "true" |
| 37 | +
|
| 38 | +# After: |
| 39 | +env: |
| 40 | + DEPLOY_TARGET: "github-pages" |
| 41 | +``` |
| 42 | + |
| 43 | +### Why This Works |
| 44 | +1. Setting `DEPLOY_TARGET=github-pages` makes `isGitHubPages = true` in `next.config.ts` |
| 45 | +2. This enables `output: 'export'` configuration for static export |
| 46 | +3. Next.js build creates the `out` directory with static files |
| 47 | +4. The upload artifact step successfully finds and uploads `./client/out` |
| 48 | + |
| 49 | +## Verification |
| 50 | + |
| 51 | +### Tests Performed |
| 52 | +1. ✅ **Static Export Build**: Successfully built with `DEPLOY_TARGET=github-pages` |
| 53 | + - Generated 8 static pages in `client/out` |
| 54 | + - Routes: /, /contact, /events, /gallery, /live, /rsvp, /travel, /404 |
| 55 | + |
| 56 | +2. ✅ **Normal Server Build**: Successfully built without static export |
| 57 | + - Generated 27 routes (11 admin + 16 API + static pages) |
| 58 | + - Confirms server-side functionality remains intact |
| 59 | + |
| 60 | +3. ✅ **Code Quality Checks**: |
| 61 | + - Linting: No ESLint warnings or errors |
| 62 | + - Type Check: No TypeScript errors |
| 63 | + |
| 64 | +4. ✅ **Artifact Path Verification**: |
| 65 | + - Confirmed `./client/out` is accessible from repository root |
| 66 | + - Upload artifact step path is correct |
| 67 | + |
| 68 | +## Deployment Impact |
| 69 | + |
| 70 | +### Static Export Features (GitHub Pages) |
| 71 | +When deployed to GitHub Pages with `DEPLOY_TARGET=github-pages`: |
| 72 | +- ✅ Static pages: Home, Events, Gallery, Live, RSVP, Travel, Contact |
| 73 | +- ✅ Client-side routing and navigation |
| 74 | +- ✅ Static assets and images |
| 75 | +- ❌ API routes (disabled for static export) |
| 76 | +- ❌ Admin pages (require server-side authentication) |
| 77 | +- ❌ Form submissions via Next.js API (use Web3Forms instead) |
| 78 | + |
| 79 | +### Full Server Features (Hostinger VPS) |
| 80 | +When deployed to Hostinger VPS without static export: |
| 81 | +- ✅ All static pages |
| 82 | +- ✅ All API routes for backend functionality |
| 83 | +- ✅ Admin dashboard and authentication |
| 84 | +- ✅ Database integration via Prisma |
| 85 | +- ✅ Form submissions via Next.js API |
| 86 | +- ✅ Email functionality via Resend |
| 87 | +- ✅ Media uploads via Cloudinary |
| 88 | + |
| 89 | +## Recommendations |
| 90 | + |
| 91 | +### 1. Environment Variable Consistency |
| 92 | +- Keep `DEPLOY_TARGET` as the standard variable for deployment configuration |
| 93 | +- Document which environment variables control build behavior |
| 94 | +- Consider using a single source of truth for deployment config |
| 95 | + |
| 96 | +### 2. Testing Strategy |
| 97 | +- Add pre-deployment tests that verify `out` directory creation |
| 98 | +- Test both static export and server builds in CI/CD pipeline |
| 99 | +- Monitor GitHub Actions workflow runs for deployment issues |
| 100 | + |
| 101 | +### 3. Documentation Updates |
| 102 | +- Update deployment documentation to mention `DEPLOY_TARGET` variable |
| 103 | +- Add troubleshooting guide for common deployment errors |
| 104 | +- Document differences between static export and server deployment |
| 105 | + |
| 106 | +### 4. GitHub Pages Limitations |
| 107 | +- Make it clear on the website that GitHub Pages version has limited functionality |
| 108 | +- Provide contact information for users when API features are unavailable |
| 109 | +- Consider adding a banner indicating "Limited features - visit [VPS URL] for full functionality" |
| 110 | + |
| 111 | +### 5. Monitoring |
| 112 | +- Set up workflow notifications for deployment failures |
| 113 | +- Monitor GitHub Pages deployment status |
| 114 | +- Track any issues related to static export limitations |
| 115 | + |
| 116 | +## Related Files |
| 117 | +- `.github/workflows/nextjs.yml` - GitHub Pages deployment workflow |
| 118 | +- `client/next.config.ts` - Next.js configuration with deployment targets |
| 119 | +- `client/scripts/prepare-static-build.sh` - Static export preparation script |
| 120 | +- `client/scripts/restore-after-build.sh` - Post-build restoration script |
| 121 | + |
| 122 | +## Next Steps |
| 123 | +1. ✅ Fix applied and tested locally |
| 124 | +2. ⏳ Push changes and trigger GitHub Actions workflow |
| 125 | +3. ⏳ Monitor deployment to GitHub Pages |
| 126 | +4. ⏳ Verify deployed site works as expected |
| 127 | +5. ⏳ Update documentation if needed |
| 128 | + |
| 129 | +--- |
| 130 | + |
| 131 | +**Fix Date**: October 11, 2025 |
| 132 | +**Fixed By**: GitHub Copilot |
| 133 | +**Issue Reference**: #234 |
| 134 | +**Related PR**: TBD |
0 commit comments