Skip to content

deployment.md

Latest commit

 

History

History
73 lines (49 loc) · 2.1 KB

deployment.md

File metadata and controls

73 lines (49 loc) · 2.1 KB

Deployment

GitHub Pages (production)

The site deploys automatically on every push to main via .github/workflows/deploy.yml.

flowchart LR
    push["git push main"] --> ci["GitHub Actions"]
    ci --> install["npm ci"]
    install --> build["npm run build\nvite build"]
    build --> dist["dist/\nindex.html + assets/"]
    dist --> pages["GitHub Pages\nkinncj.github.io/GitHub-Copilot-Enterprise-Dashboard/"]
Loading

Base path

Vite reads GITHUB_REPOSITORY from the Actions environment and sets base to /<repo-name>/ so all asset URLs are correct under the Pages subdirectory. In local dev (GITHUB_REPOSITORY not set), base defaults to /.

This is configured in vite.config.js:

const base = process.env.GITHUB_REPOSITORY
  ? `/${process.env.GITHUB_REPOSITORY.split('/')[1]}/`
  : '/';

Local development

make dev        # http://localhost:3000 with HMR

Local production build

make build      # outputs to dist/
make preview    # serves dist/ locally at http://localhost:4173

Static hosting (not GitHub Pages)

The build output in dist/ is a standard static site. Drop it on any CDN or static host (Netlify, Cloudflare Pages, S3, etc.). The only thing to check is the base path — if the app lives at the root of a domain (https://dashboard.example.com/) use base: '/' in vite.config.js.

CI pipeline

The .github/workflows/ci.yml workflow runs on push to main and refactor:

flowchart LR
    push["push / PR"] --> install["npm ci"]
    install --> unit["vitest run\n95 unit tests"]
    unit --> build["vite build"]
    build --> playwright["playwright install chromium"]
    playwright --> e2e["playwright test\n18 e2e tests"]
    e2e --> artifacts["upload coverage\nupload playwright report on failure"]
Loading

Unit tests must pass before the build runs. E2E tests run against the compiled output.

Environment variables

No runtime environment variables are required — all processing is client-side. The only build-time variable used is GITHUB_REPOSITORY (automatically set by GitHub Actions).
⚡