Skip to content

chore: add GitHub Pages deploy workflow and docs - #63

Merged
theghost1980 merged 1 commit into
mainfrom
codex/add-github-pages-deploy-workflow-and-docs
Feb 8, 2026
Merged

theghost1980 merged 1 commit into
mainfrom
codex/add-github-pages-deploy-workflow-and-docs

Conversation

@saturnoTest

Copy link
Copy Markdown
Member

Motivation

  • Enable automatic build + deploy to GitHub Pages from this Vite + Phaser project.
  • Ensure assets resolve correctly on Pages by setting a repo-aware base for production builds.
  • Provide clear documentation in the README so repo owners can enable Pages and troubleshoot common issues.

Description

  • Add GitHub Actions workflow .github/workflows/deploy-pages.yml that runs on push to main and workflow_dispatch, installs dependencies, runs npm run typecheck and npm run build, and publishes the dist artifact via the official Pages actions with pages: write and proper concurrency.
  • Update vite.config.ts to set base dynamically during build using the GITHUB_REPOSITORY env var (computed as /${repoName}/) while keeping local dev using base: '/'.
  • Update README.md with a Deploy (GitHub Pages) section describing how to enable Pages, the expected URL (https://<OWNER>.github.io/<REPO>/), why the Vite base is needed, and short troubleshooting steps.

Testing

  • Ran npm run build locally, which executes tsc -b && vite build, and the build completed successfully.
  • The produced dist output was generated without errors (Vite reported build success).

Codex Task

@saturnoTest
saturnoTest requested a review from a team February 8, 2026 02:22

@theghost1980 theghost1980 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

final touches

@theghost1980
theghost1980 merged commit d26bc14 into main Feb 8, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants