Skip to content

Commit b62b580

Browse files
joshual-xlnxcursoragent
andcommitted
Add gh-pages branch deploy workflow and Pages setup instructions.
Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 2ce1475 commit b62b580

2 files changed

Lines changed: 52 additions & 0 deletions

File tree

.github/workflows/pages-branch.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Fallback deploy: push static site to gh-pages branch.
2+
# Use this if GitHub Actions-based Pages is not yet enabled on the repo.
3+
# Settings → Pages → Build and deployment → Deploy from branch → gh-pages / (root)
4+
name: Deploy to gh-pages branch
5+
6+
on:
7+
push:
8+
branches: ["main"]
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: write
13+
14+
concurrency:
15+
group: "pages-branch"
16+
cancel-in-progress: true
17+
18+
jobs:
19+
deploy:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v4
24+
25+
- name: Build site
26+
run: |
27+
mkdir -p _site/projects/{CV,DL,LLM,PhySim}
28+
cp index.html .nojekyll _site/
29+
cp -r assets _site/
30+
cp projects/CV/index.html _site/projects/CV/
31+
cp projects/DL/index.html _site/projects/DL/
32+
cp projects/LLM/index.html _site/projects/LLM/
33+
cp projects/PhySim/index.html _site/projects/PhySim/
34+
35+
- name: Deploy to gh-pages branch
36+
uses: peaceiris/actions-gh-pages@v4
37+
with:
38+
github_token: ${{ secrets.GITHUB_TOKEN }}
39+
publish_dir: ./_site
40+
publish_branch: gh-pages
41+
force_orphan: true

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,17 @@ These notebooks are designed to run on [AUP Learning Cloud](https://github.com/A
4747

4848
Full platform documentation: [https://amdresearch.github.io/aup-learning-cloud/](https://amdresearch.github.io/aup-learning-cloud/)
4949

50+
## GitHub Pages
51+
52+
The site is published at [https://amdresearch.github.io/aup-teaching-labs/](https://amdresearch.github.io/aup-teaching-labs/).
53+
54+
If the site shows a 404, enable GitHub Pages on the repository:
55+
56+
1. Open [Repository Settings → Pages](https://github.com/AMDResearch/aup-teaching-labs/settings/pages)
57+
2. Under **Build and deployment**, set **Source** to **Deploy from a branch**
58+
3. Choose branch **gh-pages** and folder **/ (root)**
59+
4. Save, then re-run the **Deploy to gh-pages branch** workflow from the Actions tab if needed
60+
5061
## Repository Structure
5162

5263
```

0 commit comments

Comments
 (0)