forked from eclipse-openbsw/openbsw
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Doxygen Github Action to generate docs
- Loading branch information
1 parent
b1e1b4d
commit ef54acf
Showing
6 changed files
with
2,782 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
name: Build and Deploy Doxygen Documentation | ||
|
||
on: [workflow_call, pull_request] | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: write | ||
defaults: | ||
run: | ||
working-directory: ./doc | ||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v4 | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: '3.10' | ||
|
||
- name: Install python dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
- name: Install doxygen | ||
run: | | ||
sudo apt-get update | ||
sudo apt-get install doxygen | ||
pip install coverxygen | ||
- name: Run doxygen | ||
run: doxygen Doxyfile | ||
|
||
- name: Print Doxygen Warning Log | ||
run: cat DoxygenWarningLog.txt | ||
|
||
- name: Run coverxygen | ||
run: python3 -m coverxygen --format summary --xml-dir doxygenOut/xml/ --src-dir .. --output doc-coverage.info | ||
|
||
- name: Print doc coverage | ||
run: cat doc-coverage.info | ||
|
||
- name: Zip doxygen documentation | ||
run: | | ||
mv doxygenOut/html doxygen_docs | ||
zip -r doxygen_docs.zip doxygen_docs | ||
- name: Upload doxygen_docs | ||
uses: actions/upload-artifact@v4 | ||
with: | ||
name: doxygen_docs | ||
path: ./doc/doxygen_docs.zip |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.