You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: DEPLOYMENT.md
+23-2Lines changed: 23 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,8 +11,11 @@ This site is automatically deployed to https://volttron.org via GitHub Pages whe
11
11
The production deployment workflow:
12
12
1. Installs Hugo Extended 0.126.0 and Dart Sass
13
13
2. Checks out the repository with submodules (to get the theme)
14
-
3. Builds the site using `hugo --gc --minify` in production mode
15
-
4. Deploys to GitHub Pages with the custom domain
14
+
3. Configures GitHub Pages and gets the base URL from repository settings
15
+
4. Builds the site using `hugo --gc --minify --baseURL` with the GitHub Pages configured URL
16
+
5. Deploys to GitHub Pages with the custom domain
17
+
18
+
**Important:** The workflow uses `${{ steps.pages.outputs.base_url }}` to dynamically get the custom domain configured in GitHub Pages repository settings. This ensures the site is built with the correct URLs.
16
19
17
20
**Triggers:** Pushes to `main` branch
18
21
@@ -67,6 +70,15 @@ rm -rf public/
67
70
-`static/.nojekyll` - Tells GitHub Pages not to use Jekyll
68
71
- Files in `static/` are copied to the root of `public/` during build
69
72
73
+
### GitHub Pages Settings
74
+
The custom domain **must** be configured in GitHub Pages repository settings:
75
+
1. Go to repository Settings → Pages
76
+
2. Under "Custom domain", enter: `volttron.org`
77
+
3. Wait for DNS check to complete (green checkmark)
78
+
4. Enable "Enforce HTTPS" once DNS is validated
79
+
80
+
The workflow uses `${{ steps.pages.outputs.base_url }}` to get this configured domain dynamically.
81
+
70
82
### Ignored Directories
71
83
The following directories are **build artifacts** and should NEVER be committed:
72
84
-`public/` - Generated site output
@@ -89,6 +101,15 @@ These are listed in `.gitignore` to prevent accidental commits.
89
101
- Cause: CNAME file missing or in wrong location
90
102
- Fix: Ensure `static/CNAME` exists and contains "volttron.org"
91
103
104
+
### Custom domain (volttron.org) not working
105
+
-**Cause**: Custom domain not configured in GitHub Pages repository settings
106
+
-**Fix**:
107
+
1. Go to repository Settings → Pages
108
+
2. Enter `volttron.org` in the "Custom domain" field
109
+
3. Wait for DNS check to pass (shows green checkmark)
110
+
4. The workflow will automatically use this domain via `${{ steps.pages.outputs.base_url }}`
111
+
-**Note**: The domain `volttron.net` redirects to `volttron.org` at the DNS level
0 commit comments