From 2033a6a670b3051a2efe4c0a508755221ff5ee71 Mon Sep 17 00:00:00 2001 From: Yuya Tanaka Date: Mon, 7 Oct 2024 23:07:47 +0900 Subject: [PATCH] Add GitHub Pages deployment --- .github/workflows/github-pages.yaml | 73 +++++++++++++++++++++++++++++ example/next.config.mjs | 4 +- example/src/app/page.tsx | 15 ++++-- 3 files changed, 86 insertions(+), 6 deletions(-) create mode 100644 .github/workflows/github-pages.yaml diff --git a/.github/workflows/github-pages.yaml b/.github/workflows/github-pages.yaml new file mode 100644 index 0000000..9a5e0b9 --- /dev/null +++ b/.github/workflows/github-pages.yaml @@ -0,0 +1,73 @@ +name: Deploy Next.js example to GitHub Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["main"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Node + uses: actions/setup-node@v4 + with: + node-version: "20" + cache: pnpm + - name: Setup Pages + uses: actions/configure-pages@v5 + with: + # Automatically inject basePath in your Next.js configuration file and disable + # server side image optimization (https://nextjs.org/docs/api-reference/next/image#unoptimized). + # + # You may remove this line if you want to manage the configuration yourself. + static_site_generator: next + - name: Restore cache + uses: actions/cache@v4 + with: + path: | + .next/cache + # Generate a new cache whenever packages or source files change. + key: ${{ runner.os }}-nextjs-${{ hashFiles('**/pnpm-lock.yaml') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }} + # If source files changed but packages didn't, rebuild from a prior cache. + restore-keys: | + ${{ runner.os }}-nextjs-${{ hashFiles('**/pnpm-lock.yaml') }}- + - name: Install dependencies + run: pnpm install --frozen-lockfile + - name: Build with Next.js + run: pnpm run build + working-directory: example + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: ./example/out + + # Deployment job + 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 diff --git a/example/next.config.mjs b/example/next.config.mjs index 4678774..9a01e26 100644 --- a/example/next.config.mjs +++ b/example/next.config.mjs @@ -1,4 +1,6 @@ /** @type {import('next').NextConfig} */ -const nextConfig = {}; +const nextConfig = { + output: 'export' +}; export default nextConfig; diff --git a/example/src/app/page.tsx b/example/src/app/page.tsx index e4570cf..d1da608 100644 --- a/example/src/app/page.tsx +++ b/example/src/app/page.tsx @@ -1,7 +1,12 @@ -// import Image from "next/image"; -import { redirect } from "next/navigation"; -import styles from "./page.module.css"; - export default function Home() { - redirect("/page1"); + return ( +
+
+ App Router +
+
+ Pages Router +
+
+ ); }