ci+quality: structural gates (CI: 3 new; local: 7 new + .clang-tidy)
CI gates (active on every PR via .gitea/workflows/)
───────────────────────────────────────────────────
1. test-count consistency
cpp-tests.yml gains a step after test-cgal that runs
`scripts/check-test-counts.sh` against the just-built ./build dir
(reuse via new BUILD_DIR env var, ~5 s overhead). Drift between
`doc/api/tests.md` and ctest reality now fails the PR.
2. End-to-end smoke
`scripts/try_it.sh` (the documented user quick-start) is now part of
the CGAL job, so README quick-start regressions fail the PR rather
than silently breaking when users land.
3. Internal markdown link checker
New `.gitea/workflows/markdown-links.yml` + `scripts/check-markdown
-links.py`. PRs that touch any *.md file run the check; main pushes
trigger it too; a weekly cron catches external link rot. Pure
Python, no third-party action. Validated against the current tree:
122 internal links across 37 *.md files, 0 broken.
Local quality scripts (`scripts/quality/`, not in CI)
─────────────────────────────────────────────────────
* `license-headers.sh` — `SPDX-License-Identifier: MIT` audit over
code/{include,src,tests}/. Currently
reports 60/66 files missing it — that's
a follow-up; the script captures the
structural gap.
* `sanitizers.sh` — ASan + UBSan over the fast test suite.
* `coverage.sh` — gcov/lcov line + branch coverage of
code/include/, HTML report under
build-coverage/lcov-html/.
* `clang-tidy.sh` — runs the curated `.clang-tidy` policy over
every public header.
* `multi-compiler.sh` — sequential build + test against every
detected g++/clang++ (auto-discovery or
explicit list).
* `cgal-version-matrix.sh`— sequential build + CGAL test suite against
every CGAL tree under `~/cgal/<ver>/` (or
via `CGAL_ROOTS=...` env var).
* `reproducible-build.sh`— two `Release -j1` builds, fail if any test
executable byte-differs.
* `run-all.sh` — driver: `--fast` for the ~5-min subset,
no arg for the ~25–40 min full sweep;
captures per-gate logs to
build-quality-logs/.
+ `.clang-tidy` — curated, deliberately-small policy (only
checks that fire on OUR code, never on
transitive CGAL/Eigen/Boost headers).
+ `scripts/quality/README.md` — explains the structure, lists each
gate's wall-time + prereqs, and codifies
the promotion path: a gate moves into CI
only when it's green on the dev machine
AND has a recovery-instructions paragraph
in `doc/release-policy.md`.
Doc updates
───────────
`doc/architecture/locked-vs-flexible.md` (reviewer-facing) gains 4
"closed" rows in the limitations table — the 3 CI gates above and the
local quality-script suite.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
45
.clang-tidy
Normal file
45
.clang-tidy
Normal file
@@ -0,0 +1,45 @@
|
||||
# conformallab++ clang-tidy policy
|
||||
#
|
||||
# Curated, deliberately small. The CGAL header tree triggers tens of
|
||||
# thousands of warnings under default settings (CGAL's chosen style is
|
||||
# pre-C++17 in many places). Restricting to checks that fire on OUR
|
||||
# code, not on transitive CGAL/Eigen/Boost headers, keeps the signal
|
||||
# meaningful.
|
||||
#
|
||||
# Promotion gate: a check moves into this list only when (a) it fires
|
||||
# on code we authored AND (b) the fix is mechanical (no algorithmic
|
||||
# rewrite required). Anything algorithmic belongs in a code review,
|
||||
# not in a static analyser.
|
||||
|
||||
Checks: >
|
||||
-*,
|
||||
bugprone-too-small-loop-variable,
|
||||
bugprone-use-after-move,
|
||||
bugprone-undefined-memory-manipulation,
|
||||
bugprone-integer-division,
|
||||
bugprone-suspicious-string-compare,
|
||||
bugprone-misplaced-widening-cast,
|
||||
bugprone-sizeof-expression,
|
||||
cppcoreguidelines-init-variables,
|
||||
cppcoreguidelines-pro-type-member-init,
|
||||
performance-for-range-copy,
|
||||
performance-implicit-conversion-in-loop,
|
||||
performance-unnecessary-copy-initialization,
|
||||
performance-unnecessary-value-param,
|
||||
readability-misleading-indentation,
|
||||
readability-redundant-smartptr-get,
|
||||
modernize-use-nullptr,
|
||||
modernize-use-override,
|
||||
modernize-deprecated-headers
|
||||
|
||||
# Only emit warnings on our own headers. CGAL/Eigen/etc. live under
|
||||
# `code/deps/` (vendored) or are installed system-wide; we never want
|
||||
# clang-tidy fixes for them.
|
||||
HeaderFilterRegex: '^.*/code/include/(?!deps/).*$'
|
||||
|
||||
WarningsAsErrors: ''
|
||||
|
||||
CheckOptions:
|
||||
- { key: cppcoreguidelines-init-variables.IgnoreArrays, value: true }
|
||||
- { key: performance-for-range-copy.WarnOnAllAutoCopies, value: true }
|
||||
- { key: performance-unnecessary-value-param.AllowedTypes, value: 'Eigen::Vector.*;Eigen::Matrix.*' }
|
||||
Reference in New Issue
Block a user