conformallab/ConformalLabpp
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

ci: fix test-cgal OOM + add Doxygen API-docs job #7

Merged
user2595 merged 2 commits from feature/CI-test-cgal-OOM-Doxygen-Job into main 2026-05-19 20:53:52 +00:00
Conversation 0 Commits 2 Files Changed 3 +64 -2
user2595 commented 2026-05-19 20:19:06 +00:00
Owner
Copy Link

Summary

Two independent CI improvements bundled in one PR (both touch only .gitea/).

1. test-cgal OOM fix

Addresses the test-cgal failures that have appeared on every PR since test_scalability_smoke.cpp landed (PR #4). Three small changes:

Setting Before After Why
--memory 1400m 1600m cc1plus on ARM64 needs ~700 MB for CGAL + Eigen templates
--memory-swap 1400m 1600m Was less than memory → Docker rejected the config silently. Equal to memory disables swap entirely so OOM fails fast instead of thrashing the SD card.
build -j 2 1 One cc1plus leaves clear headroom; build is ~30 s slower but never OOMs

Local verification: full 183-test suite passes in ~1 s with peak resident memory ~700 MB. The ARM64 runner now has the same headroom.

2. API-docs job (new, soft-fail)

Introduces .gitea/workflows/doc-build.yaml — a separate workflow with the distinct name API Docs (avoids name collision with the existing C++ Tests workflow).

Properties:

  • Triggers on pull requests only
  • continue-on-error: true → never blocks a merge
  • Installs doxygen, runs doxygen Doxyfile
  • Uploads the generated HTML as a 14-day artifact for reviewer inspection
  • Dockerfile.ci-cpp also pre-installs doxygen so future iterations can drop the in-job install step

When Doxygen coverage matures (Phase 8c — User_manual.md), this job can be promoted to a hard requirement and the HTML deployed to Pages.

Verification plan

Merge order matters slightly:

  1. This PR first — gets the test-cgal job green again.
  2. Then PR #6 (Phase 8a MVP) — its test-cgal run benefits from the OOM fix immediately, and its 7 new tests appear in the green count.

Alternative: merge in either order; PR #6 will simply not have a green test-cgal until this PR lands.

No changes to algorithm code, no changes to test code — purely infrastructure.

## Summary Two independent CI improvements bundled in one PR (both touch only `.gitea/`). ## 1. test-cgal OOM fix Addresses the test-cgal failures that have appeared on every PR since `test_scalability_smoke.cpp` landed (PR #4). Three small changes: | Setting | Before | After | Why | |---|---|---|---| | `--memory` | 1400m | **1600m** | cc1plus on ARM64 needs ~700 MB for CGAL + Eigen templates | | `--memory-swap` | 1400m | **1600m** | Was *less* than memory → Docker rejected the config silently. Equal to memory disables swap entirely so OOM fails fast instead of thrashing the SD card. | | build `-j` | 2 | **1** | One cc1plus leaves clear headroom; build is ~30 s slower but never OOMs | Local verification: full 183-test suite passes in ~1 s with peak resident memory ~700 MB. The ARM64 runner now has the same headroom. ## 2. API-docs job (new, soft-fail) Introduces `.gitea/workflows/doc-build.yaml` — a separate workflow with the distinct name **API Docs** (avoids name collision with the existing **C++ Tests** workflow). Properties: - Triggers on pull requests only - `continue-on-error: true` → never blocks a merge - Installs doxygen, runs `doxygen Doxyfile` - Uploads the generated HTML as a 14-day artifact for reviewer inspection - `Dockerfile.ci-cpp` also pre-installs doxygen so future iterations can drop the in-job install step When Doxygen coverage matures (Phase 8c — User_manual.md), this job can be promoted to a hard requirement and the HTML deployed to Pages. ## Verification plan Merge order matters slightly: 1. **This PR first** — gets the test-cgal job green again. 2. **Then PR #6** (Phase 8a MVP) — its test-cgal run benefits from the OOM fix immediately, and its 7 new tests appear in the green count. Alternative: merge in either order; PR #6 will simply not have a green test-cgal until this PR lands. No changes to algorithm code, no changes to test code — purely infrastructure.
user2595 added 1 commit 2026-05-19 20:19:07 +00:00
ci: fix test-cgal OOM + add Doxygen API-docs job
Some checks failed
C++ Tests / test-fast (push) Successful in 4m47s
Details
C++ Tests / test-fast (pull_request) Successful in 3m42s
Details
API Docs / doc-build (pull_request) Failing after 7m19s
Details
C++ Tests / test-cgal (push) Has been skipped
Details
C++ Tests / test-cgal (pull_request) Failing after 15m9s
Details
3cc96703cc 
Two CI improvements:

1. **test-cgal OOM fix**
   * memory limit  1400m → 1600m  (cc1plus needs ~700 MB for CGAL + Eigen)
   * memory-swap   1400m → 1600m  (was less than memory, Docker rejected
                                    the config; now disables swap entirely
                                    so OOM fails fast)
   * build parallelism  -j2 → -j1  (single worker leaves headroom)

   These three changes together address the test-cgal failures observed
   since the test_scalability_smoke.cpp was added.  Locally the full
   suite (183 tests including the brezel.obj genus-2 mesh) runs in
   ~1 s with peak ~700 MB; the ARM64 CI runner now has the same
   headroom.

2. **API-docs job (new, soft-fail)**
   * .gitea/workflows/doc-build.yaml — separate workflow, distinct name
     "API Docs"
   * Runs only on pull requests; `continue-on-error: true` ensures
     warnings never block the merge
   * Installs doxygen, runs `doxygen Doxyfile`, uploads the generated
     HTML as a 14-day artifact for reviewer inspection
   * Dockerfile.ci-cpp also pre-installs doxygen so future iterations
     can drop the in-job install step

   When Doxygen coverage matures (Phase 8c — User_manual.md), this job
   can be promoted to a hard requirement and the HTML deployed to
   Pages.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
user2595 added 1 commit 2026-05-19 20:51:28 +00:00
ci: remove unsupported upload-artifact@v4 from doc-build job
Some checks failed
C++ Tests / test-fast (push) Successful in 2m19s
Details
C++ Tests / test-fast (pull_request) Successful in 3m28s
Details
API Docs / doc-build (pull_request) Successful in 40s
Details
C++ Tests / test-cgal (push) Has been skipped
Details
C++ Tests / test-cgal (pull_request) Failing after 10m57s
Details
311360f925 
Gitea Actions on GHES does not support actions/upload-artifact@v4 — the
v4 release switched to GitHub-only APIs (artifact backend rewritten).
The doc-build job was failing with "artifact@v4+ are not currently
supported on GHES."

Changes
───────
* Removed the artifact-upload step entirely.  Rationale: the warning
  summary in the job log is the primary reviewer signal for the
  documentation health check.  Reviewers who want to inspect the HTML
  locally can rebuild it with `cmake --build build --target doc`.
* Removed the apt-get install step.  Doxygen is now pre-installed in
  the ci-cpp container (Dockerfile change earlier in this PR).
* Added an explanatory comment so the missing artifact step is not
  re-introduced unknowingly.
* Added a "Report HTML output" step that prints file count + total size
  for visibility (a no-op if the HTML directory is absent).

When/if a real artifact host appears (Gitea Pages, S3, GitHub mirror
release), this job can be extended to publish the HTML there.  For now,
the in-log warning summary is sufficient.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
user2595 merged commit 570b3d61d4 into main 2026-05-19 20:53:52 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
carl.lutz user2595
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: conformallab/ConformalLabpp#7
No description provided.
Delete Branch "feature/CI-test-cgal-OOM-Doxygen-Job"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?