Skip to content

Commit

Permalink
Add GitHub Pages deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
ypresto committed Oct 7, 2024
1 parent 9b1edfe commit 2033a6a
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 6 deletions.
73 changes: 73 additions & 0 deletions .github/workflows/github-pages.yaml
Original file line number Diff line number Diff line change
@@ -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
4 changes: 3 additions & 1 deletion example/next.config.mjs
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
/** @type {import('next').NextConfig} */
const nextConfig = {};
const nextConfig = {
output: 'export'
};

export default nextConfig;
15 changes: 10 additions & 5 deletions example/src/app/page.tsx
Original file line number Diff line number Diff line change
@@ -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 (
<div>
<div>
<a href="/page1">App Router</a>
</div>
<div>
<a href="/page1">Pages Router</a>
</div>
</div>
);
}

0 comments on commit 2033a6a

Please sign in to comment.