Skip to content

Commit 4e9dae1

Browse files
authored
Merge pull request #2 from OSSPhilippines/copilot/setup-github-workflow-for-nextjs
Add GitHub Actions workflow for automated deployment to GitHub Pages
2 parents 0e12658 + f5153e6 commit 4e9dae1

File tree

4 files changed

+75
-0
lines changed

4 files changed

+75
-0
lines changed

.github/workflows/deploy.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Deploy Next.js to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v4
24+
25+
- name: Setup Node.js
26+
uses: actions/setup-node@v4
27+
with:
28+
node-version: '20'
29+
cache: 'npm'
30+
31+
- name: Install dependencies
32+
run: npm ci
33+
34+
- name: Build Next.js app
35+
run: npm run build
36+
37+
- name: Upload artifact
38+
uses: actions/upload-pages-artifact@v3
39+
with:
40+
path: ./out
41+
42+
deploy:
43+
environment:
44+
name: github-pages
45+
url: ${{ steps.deployment.outputs.page_url }}
46+
runs-on: ubuntu-latest
47+
needs: build
48+
steps:
49+
- name: Deploy to GitHub Pages
50+
id: deployment
51+
uses: actions/deploy-pages@v4

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,26 @@ npm start
4646

4747
Open [http://localhost:3000](http://localhost:3000) to view the website.
4848

49+
## 🚀 Deployment
50+
51+
### GitHub Pages
52+
53+
This project is configured to automatically deploy to GitHub Pages on every push to the `main` branch.
54+
55+
#### Setup Instructions:
56+
57+
1. Go to your repository **Settings****Pages**
58+
2. Under **Source**, select **GitHub Actions**
59+
3. Push to the `main` branch to trigger the deployment workflow
60+
4. Your site will be available at `https://<username>.github.io/<repository-name>/`
61+
62+
The deployment workflow:
63+
- Builds the Next.js app as a static site
64+
- Exports all pages as SEO-friendly HTML
65+
- Automatically deploys to GitHub Pages
66+
67+
See `.github/workflows/deploy.yml` for the workflow configuration.
68+
4969
## 📁 Project Structure
5070

5171
```

next.config.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ const nextConfig: NextConfig = {
44
reactStrictMode: true,
55
poweredByHeader: false,
66
compress: true,
7+
output: 'export',
8+
images: {
9+
unoptimized: true,
10+
},
711
};
812

913
export default nextConfig;

public/.nojekyll

Whitespace-only changes.

0 commit comments

Comments
 (0)