Skip to content

Commit c73393b

Browse files
committed
feat: add GitHub Actions workflow for deploying documentation to GitHub Pages
1 parent e3377a8 commit c73393b

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

.github/workflows/gh-pages.yml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
on:
2+
push:
3+
branches:
4+
- main
5+
6+
permissions:
7+
actions: read
8+
pages: write
9+
id-token: write
10+
11+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
12+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: false
16+
17+
jobs:
18+
publish-docs:
19+
environment:
20+
name: github-pages
21+
url: ${{ steps.deployment.outputs.page_url }}
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v3
26+
- name: Dotnet Setup
27+
uses: actions/setup-dotnet@v3
28+
with:
29+
dotnet-version: 8.x
30+
31+
- run: dotnet tool update -g docfx
32+
- run: docfx docfx.json
33+
34+
- name: Upload artifact
35+
uses: actions/upload-pages-artifact@v3
36+
with:
37+
# Upload entire repository
38+
path: '_site'
39+
- name: Deploy to GitHub Pages
40+
id: deployment
41+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)