Skip to content

Conversation

@fx
Copy link
Owner

@fx fx commented Jul 7, 2025

Summary

  • Add GitHub Actions workflow to automatically build and deploy to GitHub Pages
  • Create production build configuration for minified output
  • Add landing page with installation instructions
  • Update documentation with GitHub Pages deployment options

Details

This PR sets up automatic deployment to GitHub Pages whenever changes are pushed to the main branch. Users will be able to use the hosted version at https://fx.github.io/liebe/panel.js without needing to build or host the panel themselves.

Changes Made:

  1. GitHub Actions Workflow (.github/workflows/deploy.yml):

    • Builds the Home Assistant panel in production mode
    • Creates GitHub Pages artifacts
    • Deploys to GitHub Pages with proper permissions
  2. Production Build Config (vite.config.ha.prod.ts):

    • Minified output for smaller file size
    • Production mode settings
    • Source maps disabled
  3. Landing Page (.github/pages-index.html):

    • Simple installation instructions
    • Links to repository and panel.js
  4. Documentation Updates:

    • Updated README.md with GitHub Pages installation option
    • Added deployment section to CLAUDE.md
    • New npm script for production builds

Testing

  • All tests pass locally (npm test)
  • Linting passes (npm run lint)
  • TypeScript checks pass (npm run typecheck)
  • Production build works (npm run build:ha:prod)
  • Workflow will be tested when merged to main

Deployment Notes

After merging, the workflow will:

  1. Automatically run on pushes to main
  2. Build and deploy to https://fx.github.io/liebe/
  3. Make the panel available at https://fx.github.io/liebe/panel.js

Users can then simply add this URL to their Home Assistant configuration without needing to build or host anything themselves.

@fx fx force-pushed the feat/github-pages-deployment branch from 276cca0 to 90a8a14 Compare July 7, 2025 21:55
Repository owner deleted a comment from github-actions bot Jul 7, 2025
@fx fx merged commit 503694b into main Jul 7, 2025
4 checks passed
@fx fx deleted the feat/github-pages-deployment branch July 7, 2025 22:14
fx added a commit that referenced this pull request Jul 7, 2025
fx added a commit that referenced this pull request Jul 7, 2025
fx added a commit that referenced this pull request Jul 7, 2025
fx added a commit that referenced this pull request Jul 8, 2025
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.

2 participants