Skip to content

Commit fc49d23

Browse files
committed
Deploy Doxygen docs to GitHub Pages
https://lifting-bits.github.io/sleigh
1 parent 1df5e05 commit fc49d23

1 file changed

Lines changed: 53 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Documentation
2+
3+
on:
4+
release:
5+
types: [published]
6+
workflow_dispatch: # manual trigger
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 only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
15+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
16+
concurrency:
17+
group: pages
18+
cancel-in-progress: false
19+
20+
jobs:
21+
deploy:
22+
runs-on: ubuntu-latest
23+
24+
environment:
25+
name: github-pages
26+
url: ${{ steps.deployment.outputs.page_url }}
27+
28+
steps:
29+
- uses: actions/checkout@v6
30+
31+
- name: Setup Git User for Applying Patches
32+
# See this thread for more details https://github.qkg1.topmunity/t/github-actions-bot-email-address/17204/5
33+
run: |
34+
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
35+
git config --global user.name "github-actions[bot]"
36+
37+
- name: Install dependencies
38+
run: sudo apt-get update && sudo apt-get install -y doxygen graphviz
39+
40+
- name: Configure
41+
run: cmake --preset=ci-ubuntu -Dsleigh_RELEASE_TYPE=stable
42+
43+
- name: Build documentation
44+
run: cmake --build build --target docs
45+
46+
- name: Upload Pages artifact
47+
uses: actions/upload-pages-artifact@v3
48+
with:
49+
path: build/docs/html
50+
51+
- name: Deploy to GitHub Pages
52+
id: deployment
53+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)