Enhance GitHub Pages deployment support in Next.js configuration and add GitHub Actions workflow for deployment.

- Updated `next.config.mjs` to enable static export for GitHub Pages and maintain backward compatibility for production builds.
- Introduced `.github/workflows/deploy-github-pages.yml` for automated deployment to GitHub Pages.
- Modified existing workflow in `.github/workflows/nextjs-publish.yml` to ignore API changes and support pnpm setup.

Author: gvzq

.github/workflows/deploy-github-pages.yml

@@ -0,0 +1,84 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v4
+
+      - name: Detect package manager
+        id: detect-package-manager
+        run: |
+          if [ -f "${{ github.workspace }}/yarn.lock" ]; then
+            echo "manager=yarn" >> $GITHUB_OUTPUT
+            echo "command=install" >> $GITHUB_OUTPUT
+            echo "runner=yarn" >> $GITHUB_OUTPUT
+            exit 0
+          elif [ -f "${{ github.workspace }}/pnpm-lock.yaml" ]; then
+            echo "manager=pnpm" >> $GITHUB_OUTPUT
+            echo "command=install" >> $GITHUB_OUTPUT
+            echo "runner=pnpm" >> $GITHUB_OUTPUT
+            exit 0
+          elif [ -f "${{ github.workspace }}/package.json" ]; then
+            echo "manager=npm" >> $GITHUB_OUTPUT
+            echo "command=ci" >> $GITHUB_OUTPUT
+            echo "runner=npx --no-install" >> $GITHUB_OUTPUT
+            exit 0
+          else
+            echo "Unable to determine package manager"
+            exit 1
+          fi
+
+      - name: Setup pnpm
+        if: steps.detect-package-manager.outputs.manager == 'pnpm'
+        run: npm install -g pnpm
+
+      - name: Setup Node.js ⚙️
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: ${{ steps.detect-package-manager.outputs.manager }}
+
+      - name: Install dependencies 🔧
+        run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}
+
+      - name: Setup Pages ⚙️
+        uses: actions/configure-pages@v4
+        with:
+          static_site_generator: next
+
+      - name: Build with Next.js for GitHub Pages 🏗️
+        run: DEPLOY_TARGET=github-pages ${{ steps.detect-package-manager.outputs.runner }} run build
+        env:
+          NODE_ENV: production
+
+      - name: Upload artifact 📡
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./out
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages 🚀
+        id: deployment
+        uses: actions/deploy-pages@v4 

.github/workflows/nextjs-publish.yml

@@ -8,6 +8,7 @@ on:
   # Runs on pushes targeting the default branch
   push:
     branches: ["main"]
+    paths-ignore: ['api/**'] # Don't trigger on API changes
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -40,6 +41,11 @@ jobs:
             echo "command=install" >> $GITHUB_OUTPUT
             echo "runner=yarn" >> $GITHUB_OUTPUT
             exit 0
+          elif [ -f "${{ github.workspace }}/pnpm-lock.yaml" ]; then
+            echo "manager=pnpm" >> $GITHUB_OUTPUT
+            echo "command=install" >> $GITHUB_OUTPUT
+            echo "runner=pnpm" >> $GITHUB_OUTPUT
+            exit 0
           elif [ -f "${{ github.workspace }}/package.json" ]; then
             echo "manager=npm" >> $GITHUB_OUTPUT
             echo "command=ci" >> $GITHUB_OUTPUT
@@ -50,6 +56,10 @@ jobs:
             exit 1
           fi
 
+      - name: Setup pnpm
+        if: steps.detect-package-manager.outputs.manager == 'pnpm'
+        run: npm install -g pnpm
+
       - name: Setup Node
         uses: actions/setup-node@v4
         with:

next.config.mjs

@@ -1,8 +1,28 @@
 /** @type {import('next').NextConfig} */
 const nextConfig = {
-  // Only use export for production builds
-  ...(process.env.NODE_ENV === "production" && { output: "export" }),
+  // Enable static export for GitHub Pages deployment
+  ...(process.env.DEPLOY_TARGET === "github-pages" && {
+    output: "export",
+    trailingSlash: true,
+    // Add basePath if deploying to a subdirectory (uncomment and modify if needed)
+    // basePath: "/your-repo-name",
+  }),
+
+  // Keep existing production export for backward compatibility
+  ...(process.env.NODE_ENV === "production" &&
+    process.env.DEPLOY_TARGET !== "github-pages" && {
+      output: "export",
+    }),
+
   images: { unoptimized: true },
+
+  // Disable server-side features when building for GitHub Pages
+  ...(process.env.DEPLOY_TARGET === "github-pages" && {
+    // Ensure no server-side features are used in static export
+    experimental: {
+      missingSuspenseWithCSRBailout: false,
+    },
+  }),
 };
 
 export default nextConfig;

public/.nojekyll

@@ -0,0 +1 @@
+