Skip to content

🐛 Doxygen now properly fails if docs have warnings #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kammce merged 5 commits into from
Jan 28, 2025
Merged

🐛 Doxygen now properly fails if docs have warnings #56

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
734a416
:bug: Doxygen now properly fails if docs have warnings
kammce Jan 28, 2025
31cf611
Remove continue on error to see what happens
kammce Jan 28, 2025
0caf292
Attempt #2
kammce Jan 28, 2025
96a41f1
Another attempt
kammce Jan 28, 2025
c7a5cbc
Use semicolon instead of pipe
kammce Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 6 additions & 10 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,18 +51,14 @@ jobs:
run: wget https://raw.githubusercontent.com/libhal/ci/main/doxygen.conf -O doxygen.conf

- name: 📖 Run Doxygen
id: doxygen
uses: mattnotmitt/[email protected]
continue-on-error: true
if: always()
with:
doxyfile-path: "doxygen.conf"

# Save the exit code of the last step (Doxygen run)
- name: 🧪 Capture Doxygen exit code
id: capture_doxygen_exit_code
run: echo "::set-output name=exit_code::$?"
shell: bash

# Conditionally read out any doxygen warnings only if the previous step failed
# Conditionally read out any doxygen warnings only if `doxygen_check`
# step failed.
- name: ⚠️ Read out any doxygen warnings
if: ${{ steps.capture_doxygen_exit_code.outputs.exit_code == '1' }}
run: cat doxygen_warn.log | exit 1
if: ${{ failure() && steps.doxygen.conclusion == 'failure' }}
run: cat doxygen_warn.log ; exit 1
Loading