Skip to content

Comments

feat: Add deployment improvements and GitHub Pages support#1

Open
mno-go wants to merge 1 commit intomainfrom
feature/add-github-actions-workflow
Open

feat: Add deployment improvements and GitHub Pages support#1
mno-go wants to merge 1 commit intomainfrom
feature/add-github-actions-workflow

Conversation

@mno-go
Copy link
Owner

@mno-go mno-go commented Jan 16, 2026

🚀 Enhancement: Deployment Improvements

This PR adds comprehensive deployment support for the Semantic Diff application, making it easy to deploy to GitHub Pages using multiple methods.

✨ What's Added

  • 📦 gh-pages Package: Added gh-pages as a dev dependency for easy manual deployment
  • 🔧 Deploy Script: Added npm run deploy command to package.json
  • 📝 Enhanced Documentation: Comprehensive deployment instructions in README
  • 🏷️ Package Metadata: Updated package.json with proper name and description

🛠️ Deployment Methods Supported

  1. GitHub Actions (Recommended) - Automatic deployment on push to main
  2. gh-pages CLI - Manual deployment with npm run deploy
  3. Manual Build - Build locally and push dist/ folder

📋 Usage

# Method 1: GitHub Actions (after setting up secrets)
# Just push to main branch!

# Method 2: Manual with gh-pages
export VITE_OPENAI_API_KEY="your-key"
export GITHUB_PAGES_BASE="/test/"
npm run build
npm run deploy

# Method 3: Manual build
npm run build
# Then push dist/ to gh-pages branch

🔧 Configuration Required

  • Add OPENAI_API_KEY to repository secrets for GitHub Actions
  • Set GITHUB_PAGES_BASE environment variable for correct asset paths
  • Enable GitHub Pages in repository settings

📁 Files Changed

  • package.json - Added gh-pages dependency and deploy script
  • package-lock.json - Updated with new dependencies
  • README.md - Enhanced with detailed deployment instructions

🎯 Ready for Production

This PR makes the Semantic Diff application production-ready with multiple deployment options to suit different workflows and preferences.


Note: GitHub Actions workflow file will be added in a separate commit due to OAuth scope requirements for workflow files.


Pull Request opened by Augment Code with guidance from the PR author

- Install gh-pages package for manual deployment option
- Update package.json with proper name and deploy script
- Enhance README with comprehensive deployment instructions
- Support multiple deployment methods (GitHub Actions, gh-pages, manual)

Note: GitHub Actions workflow will be added separately due to OAuth scope requirements.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant