publish

Publish Site to GitHub Pages

Build a generated report site and publish it to GitHub Pages.

Workflow

Step 1: Locate the Site

If a path was provided in the arguments, use it. Otherwise, ask the user:

• "What is the path to the generated site directory?"

Verify it's a valid site project by checking for package.json in the directory.

Step 2: Detect Project Type

Read package.json to determine the framework:

• Vite (has vite in devDependencies): build output goes to dist/
• Next.js (has next in dependencies): build output goes to out/ (requires output: "export" in next.config.ts)

Step 3: Ask Publish Method

Use AskUserQuestion to ask:

"How do you want to publish?" with options:

1. GitHub Pages (Recommended) — Create a GitHub repo, push the code, and enable GitHub Pages with automatic deployments. Every future git push will redeploy.
2. Build only — Just run the build. You'll get a folder (dist/ or out/) with static HTML/CSS/JS files you can upload anywhere (Netlify, Vercel, any web host).

Step 4: Build the Site

Run the build:

cd <site-directory>
npm install   # only if node_modules/ doesn't exist
npm run build

Verify the build succeeds and the output directory (dist/ or out/) exists.

If the build fails, diagnose and fix the error, then retry.

Step 5a: GitHub Pages Publish

If the user chose GitHub Pages:

1. Ask for repo name — Use AskUserQuestion: "What should the GitHub repository be called?" with options:

   • The site directory name (e.g., ontario-tax-valuation-site)
   • Custom name

2. Set base path — The site will be hosted at https://<username>.github.io/<repo-name>/, so asset paths need the repo name as a prefix:

   • Vite sites: Update base in vite.config.js to '/<repo-name>/'
   • Next.js sites: Add basePath: '/<repo-name>' in next.config.ts (or next.config.mjs)

   After updating the config, rebuild so the output reflects the new base path.