Skip to content

Commit bced7d5

Browse files
authored
Add GitHub Actions workflow for Doxygen documentation
1 parent 5f2882c commit bced7d5

1 file changed

Lines changed: 41 additions & 0 deletions

File tree

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Doxygen
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
tags:
7+
- "v*"
8+
pull_request:
9+
branches: [ main ]
10+
11+
permissions:
12+
contents: write
13+
14+
jobs:
15+
build:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v2
19+
20+
- name: Install epstopdf
21+
run: sudo apt-get update && sudo apt-get install -y texlive-extra-utils
22+
23+
- name: Update Doxygen version from Tag
24+
if: startsWith(github.ref, 'refs/tags/v')
25+
run: |
26+
VERSION=${GITHUB_REF#refs/tags/}
27+
echo "Updating Doxyfile version to $VERSION"
28+
sed -i "s/^PROJECT_NUMBER[[:space:]]*=.*/PROJECT_NUMBER = $VERSION/" ./appcomm/Doxyfile
29+
30+
- name: Doxygen Build
31+
uses: mattnotmitt/doxygen-action@v1.1.0
32+
with:
33+
doxyfile-path: "Doxyfile"
34+
working-directory: "./appcomm"
35+
36+
- name: Publish
37+
if: startsWith(github.ref, 'refs/tags/v')
38+
uses: peaceiris/actions-gh-pages@v3
39+
with:
40+
github_token: ${{ secrets. GITHUB_TOKEN }}
41+
publish_dir: ./docs/html

0 commit comments

Comments
 (0)