Make custom domain configurable in deploy config

Twissi · Twissi · commit d4a3971cfb2d · 2025-07-19T18:42:21.000+02:00
diff --git a/.github/workflows/deploy-github-pages.yml b/.github/workflows/deploy-github-pages.yml
@@ -38,6 +38,8 @@ jobs:
         env:
           GITHUB_ACTIONS: true
           GITHUB_REPOSITORY: ${{ github.repository }}
+          # Set CUSTOM_DOMAIN=true when using custom domain (e.g., opentechschool.org)
+          # CUSTOM_DOMAIN: true
           
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
diff --git a/README.md b/README.md
@@ -151,13 +151,15 @@ This website is deployed to GitHub Pages. Every push to the `github-pages-new` b
 
 To test the GitHub Pages build locally with the correct basePath configuration:
 
+Note: We are using `out` instead of `websitenext`, but the github action will copy files from `out` to `websitenext`
+
 ```bash
 # Build and export with GitHub Pages environment variables
-GITHUB_ACTIONS=true GITHUB_REPOSITORY=OpenTechSchool/websitenext npm run build
-GITHUB_ACTIONS=true GITHUB_REPOSITORY=OpenTechSchool/websitenext npx next export
+GITHUB_ACTIONS=true GITHUB_REPOSITORY=OpenTechSchool/out npm run build
+GITHUB_ACTIONS=true GITHUB_REPOSITORY=OpenTechSchool/out npx next export
 
 # The static files will be generated in the 'out' directory
-# All asset paths (images, fonts, links) will include the /websitenext basePath
+# All asset paths (images, fonts, links) will include the /out basePath
 ```
 
 **Important:** When building for GitHub Pages, the build process:
@@ -174,6 +176,10 @@ npm run build      # Production build (local)
 npm run export     # Static export (local)
 ```
 
+### Using a custom domain
+
+Set `CUSTOM_DOMAIN` to true in `deploy-github-pages.yml` when using a custom domain e.g. opentechschool.org
+
 ## Contact
 
 Found an issue, a bug or have an idea for a great new feature?
diff --git a/next.config.js b/next.config.js
@@ -1,11 +1,12 @@
 const path = require('path')
 
 const isGithubActions = process.env.GITHUB_ACTIONS || false
+const hasCustomDomain = process.env.CUSTOM_DOMAIN === 'true'
 
 let assetPrefix = ''
 let basePath = ''
 
-if (isGithubActions) {
+if (isGithubActions && !hasCustomDomain) {
   const repo = process.env.GITHUB_REPOSITORY.replace(/.*?\//, '')
   assetPrefix = `/${repo}/`
   basePath = `/${repo}`
@@ -36,5 +37,6 @@ module.exports = {
     // Make build-time environment variables available at runtime
     NEXT_PUBLIC_GITHUB_ACTIONS: process.env.GITHUB_ACTIONS || 'false',
     NEXT_PUBLIC_GITHUB_REPOSITORY: process.env.GITHUB_REPOSITORY || '',
+    NEXT_PUBLIC_CUSTOM_DOMAIN: process.env.CUSTOM_DOMAIN || 'false',
   },
 }
diff --git a/pages/_document.tsx b/pages/_document.tsx
@@ -4,7 +4,8 @@ import Document, { Html, Head, Main, NextScript } from 'next/document'
 export default class MyDocument extends Document {
   render() {
     const isGithubActions = process.env.GITHUB_ACTIONS || false
-    const basePath = isGithubActions ? `/${process.env.GITHUB_REPOSITORY?.replace(/.*?\//, '') || ''}` : ''
+    const hasCustomDomain = process.env.CUSTOM_DOMAIN === 'true'
+    const basePath = (isGithubActions && !hasCustomDomain) ? `/${process.env.GITHUB_REPOSITORY?.replace(/.*?\//, '') || ''}` : ''
     
     return (
       <Html lang='en'>
diff --git a/style/style-global.js b/style/style-global.js
@@ -2,7 +2,8 @@ import css from 'styled-jsx/css'
 import { mediaquery } from './style.js'
 
 const isGithubActions = process.env.NEXT_PUBLIC_GITHUB_ACTIONS || false
-const basePath = isGithubActions ? `/${process.env.NEXT_PUBLIC_GITHUB_REPOSITORY?.replace(/.*?\//, '') || ''}` : ''
+const hasCustomDomain = process.env.NEXT_PUBLIC_CUSTOM_DOMAIN === 'true'
+const basePath = (isGithubActions && !hasCustomDomain) ? `/${process.env.NEXT_PUBLIC_GITHUB_REPOSITORY?.replace(/.*?\//, '') || ''}` : ''
 
 export default css.global`
   :root {
