Skip to content

Commit 2e7f7c0

Browse files
committed
add doc github action
1 parent 6d24b4d commit 2e7f7c0

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

.github/workflows/doc.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: DocC Runner
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
workflow_dispatch:
7+
8+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
# Allow one concurrent deployment
15+
concurrency:
16+
group: "pages"
17+
cancel-in-progress: true
18+
19+
# A single job that builds and deploys the DocC documentation
20+
jobs:
21+
deploy:
22+
environment:
23+
name: github-pages
24+
url: ${{ steps.deployment.outputs.page_url }}
25+
runs-on: ubuntu-latest
26+
steps:
27+
- name: Checkout
28+
uses: actions/checkout@v5
29+
- name: Setup Pages
30+
uses: actions/configure-pages@v5
31+
- name: Build DocC
32+
run: |
33+
make generate-doc
34+
- name: Upload artifact
35+
uses: actions/upload-pages-artifact@v4
36+
with:
37+
path: 'docs'
38+
- id: deployment
39+
name: Deploy to GitHub Pages
40+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)