Skip to content

Commit caf900f

Browse files
committed
refactor: update GitHub Actions workflow for documentation deployment
1 parent 9b7ba3d commit caf900f

1 file changed

Lines changed: 34 additions & 10 deletions

File tree

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,57 @@
1-
name: Deploy to GitHub Pages
1+
name: Deploy Documentation to GitHub Pages
22

33
on:
44
push:
55
branches:
66
- master
77
paths:
88
- 'docs/**'
9+
- 'src/**'
10+
- 'scripts/**'
11+
- 'package.json'
912
- '.github/workflows/docs-deployment.yml'
13+
workflow_dispatch:
14+
15+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
16+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
17+
concurrency:
18+
group: "pages"
19+
cancel-in-progress: false
1020

1121
jobs:
1222
deploy:
23+
environment:
24+
name: github-pages
25+
url: ${{ steps.deployment.outputs.page_url }}
1326
runs-on: ubuntu-latest
27+
permissions:
28+
contents: read
29+
pages: write
30+
id-token: write
1431
steps:
1532
- name: Checkout
16-
uses: actions/checkout@v2
33+
uses: actions/checkout@v4
1734

1835
- name: Setup Node.js
19-
uses: actions/setup-node@v2
36+
uses: actions/setup-node@v4
2037
with:
2138
node-version: '20'
39+
cache: 'npm'
2240

2341
- name: Install Dependencies
24-
run: cd docs && npm install
42+
run: npm ci
43+
44+
- name: Build Documentation
45+
run: npm run docs:build
2546

26-
- name: Build
27-
run: cd docs && npm run build
47+
- name: Setup Pages
48+
uses: actions/configure-pages@v4
2849

29-
- name: Deploy
30-
uses: peaceiris/actions-gh-pages@v3
50+
- name: Upload artifact
51+
uses: actions/upload-pages-artifact@v3
3152
with:
32-
github_token: ${{ secrets.GH_TOKEN }}
33-
publish_dir: ./docs/build
53+
path: ./docs/build
54+
55+
- name: Deploy to GitHub Pages
56+
id: deployment
57+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)