Skip to content

[Fix][Workflow] doxygen Doxyfile 返回错误 但是仍然生成成功 #10596

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+15 −6
Open

[Fix][Workflow] doxygen Doxyfile 返回错误 但是仍然生成成功 #10596

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 15 additions & 6 deletions .github/workflows/doxygen.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ on:
schedule:
- cron: '0 16 30 * *'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

jobs:
build:
runs-on: ubuntu-22.04
Expand All @@ -55,15 +55,24 @@ jobs:
shell: bash
run: |
cd documentation
doxygen Doxyfile
cat Doxyfile

if ! doxygen Doxyfile; then
echo "Doxygen failed, but workflow will continue."
Comment on lines +58 to +59
Copy link
Preview

Copilot AI Aug 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider capturing and logging the specific Doxygen error output to aid in debugging. You could redirect stderr to a variable or file for later inspection.

Suggested change
if ! doxygen Doxyfile; then
echo "Doxygen failed, but workflow will continue."
if ! doxygen Doxyfile 2> doxygen_error.log; then
echo "Doxygen failed, but workflow will continue."
echo "---- Doxygen error output ----"
cat doxygen_error.log
echo "-----------------------------"

Copilot uses AI. Check for mistakes.

fi

# 检查生成结果
Copy link
Preview

Copilot AI Aug 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The comment is in Chinese while the rest of the workflow file appears to use English. Consider using English for consistency: '# Check generation results'.

Suggested change
# 检查生成结果
# Check generation results

Copilot uses AI. Check for mistakes.

if [ -d "html" ]; then
echo "✅ HTML documentation generated successfully."
else
echo "❌ Warning: HTML directory not found."
exit 1
fi

- name: Upload static files as artifact
id: deployment
uses: actions/upload-pages-artifact@main # or specific "vX.X.X" version tag for this action
with:
path: documentation/html/

deploy:
if: github.event_name == 'push'
environment:
Expand Down