ci: fix test-cgal OOM + add Doxygen API-docs job #7
@@ -9,12 +9,16 @@ on:
|
||||
# ─────────────────────────────────────────────────────────────────────────────
|
||||
# Doc-build — informational only
|
||||
#
|
||||
# Generates Doxygen HTML from the public headers and uploads it as an
|
||||
# artifact for reviewer inspection. Does NOT block merges:
|
||||
# `continue-on-error: true` ensures warnings or extraction issues never
|
||||
# fail the CI gate. When Doxygen coverage is denser (Phase 8c), this job
|
||||
# can be promoted to a hard requirement and the artifact deployed to
|
||||
# Pages.
|
||||
# Generates Doxygen HTML from the public headers and reports warning
|
||||
# statistics. Does NOT block merges: `continue-on-error: true` ensures
|
||||
# warnings or extraction issues never fail the CI gate. When Doxygen
|
||||
# coverage is denser (Phase 8c), this job can be promoted to a hard
|
||||
# requirement and the HTML deployed to Pages.
|
||||
#
|
||||
# Note: Gitea Actions on GHES does not support `actions/upload-artifact@v4`,
|
||||
# so HTML artifact upload is intentionally omitted. The warning summary
|
||||
# in the job log is the primary reviewer signal; reviewers who want the
|
||||
# HTML can rebuild it locally with `cmake --build build --target doc`.
|
||||
# ─────────────────────────────────────────────────────────────────────────────
|
||||
jobs:
|
||||
doc-build:
|
||||
@@ -26,9 +30,6 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Install Doxygen
|
||||
run: apt-get update && apt-get install -y --no-install-recommends doxygen
|
||||
|
||||
- name: Generate API documentation
|
||||
run: doxygen Doxyfile 2>&1 | tee doxygen.log
|
||||
|
||||
@@ -38,13 +39,18 @@ jobs:
|
||||
if [ -f doc/doxygen/doxygen-warnings.log ]; then
|
||||
warn=$(wc -l < doc/doxygen/doxygen-warnings.log)
|
||||
echo "DOC ▸ Doxygen warnings: $warn"
|
||||
echo ""
|
||||
echo "First 20 warnings:"
|
||||
head -20 doc/doxygen/doxygen-warnings.log
|
||||
else
|
||||
echo "DOC ▸ No warning log produced — check that Doxyfile WARN_LOGFILE points to doc/doxygen/doxygen-warnings.log"
|
||||
fi
|
||||
|
||||
- name: Upload HTML as artifact
|
||||
- name: Report HTML output
|
||||
if: always()
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: doxygen-html
|
||||
path: doc/doxygen/html/
|
||||
retention-days: 14
|
||||
run: |
|
||||
if [ -d doc/doxygen/html ]; then
|
||||
files=$(find doc/doxygen/html -type f | wc -l)
|
||||
size=$(du -sh doc/doxygen/html | cut -f1)
|
||||
echo "DOC ▸ HTML output: $files files, $size total"
|
||||
fi
|
||||
|
||||
Reference in New Issue
Block a user