Skip to content

Commit 7b743e8

Browse files
committed
Add GitHub Actions workflow for generating Doxygen documentation
1 parent 58973bc commit 7b743e8

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

.github/workflows/doxygen.yaml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Generate Doxygen Documentation
2+
3+
on:
4+
push:
5+
branches: [master]
6+
pull_request:
7+
branches: [master]
8+
9+
jobs:
10+
doxygen:
11+
name: Build & Deploy Doxygen Docs
12+
runs-on: ubuntu-latest
13+
# Skip CI on generated commits
14+
if: "!contains(github.event.head_commit.message, 'skip ci')"
15+
16+
steps:
17+
- name: Check out repository
18+
uses: actions/checkout@v3
19+
with:
20+
persist-credentials: true # so we can push back to repo
21+
fetch-depth: 0 # needed to push commits
22+
23+
- name: Install dependencies
24+
run: |
25+
sudo apt-get update
26+
sudo apt-get install -y doxygen graphviz
27+
28+
- name: Prepare Doxyfile
29+
# Use configure script to generate Doxyfile (Doxyfile.in must exist)
30+
run: ./configure
31+
32+
- name: Generate documentation
33+
run: doxygen Doxyfile
34+
35+
- name: Commit and push docs
36+
run: |
37+
git config user.name "github-actions[bot]"
38+
git config user.email "github-actions[bot]@users.noreply.github.com"
39+
git add docs
40+
git commit -m "chore: update Doxygen docs [skip ci]" || echo "No changes to commit"
41+
git push origin HEAD:master

0 commit comments

Comments
 (0)