Story: Improve CDash build visibility
Table of Contents
This page documents a story in Sprint 20. It captures the goal, current status, acceptance criteria, and the tasks that compose it.
Goal
CDash gives developers and new contributors a clear, actionable view of
build health: each canary entry links to the PR that triggered it via a
Notes field; site builds appear in a dedicated Site category so
documentation health is visible at a glance. The Canary category already
exists. The build names are unchanged.
Status
| Field | Value |
|---|---|
| State | DONE |
| Parent sprint | Sprint 20 |
| Now | Nothing. |
| Waiting on | Nothing. |
| Next | Nothing. |
| Last touched | 2026-06-09 |
Acceptance
- CDash canary entries show the PR URL in their Notes section.
- Site builds appear under the
SiteCDash category after a site build run. Experimentalremains inCTest.cmakeas a reserved valid value but is not invoked by any workflow.
Tasks
| Task | State | Start | End | Description |
|---|---|---|---|---|
| Link canary CDash builds to their PR via Notes | DONE | 2026-06-09 | 2026-06-09 | Write PR URL to CTEST_NOTES_FILES in CTest.cmake; thread pr_number through canary-linux.yml. |
| Add CDash Site category for doc builds | DONE | 2026-06-09 | CTest.site.cmake script; update build-site.yml to submit; Canary already exists. | |
| Use Continuous group and record revision in CDash site builds | DONE | 2026-06-09 | 2026-06-09 | Investigated CTest model names and CDash group; PR #1218 closed — Experimental + -site suffix is sufficient. |
Decisions
- CDash Notes (
CTEST_NOTES_FILES) rather thanbuild_postfix— the build name stays clean; the PR URL lives in the Notes section. - Site builds use a separate
CTest.site.cmake(notCTest.cmake) because they do not use CMake presets or the configure/build/test pipeline. Experimentalis the designated group for local developer builds — kept inCTest.cmakeand intentionally never invoked by CI workflows.
Out of scope
- Changing the Nightly or Continuous group naming (they match CDash defaults).
- Windows or macOS site builds (docs are built on Linux only).