a2eee9c279
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>
76 lines
2.3 KiB
Bash
Executable File
76 lines
2.3 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# Requires bash ≥ 4 for `mapfile`; on macOS install via `brew install bash`
|
|
# and invoke as `bash scripts/quality/license-headers.sh`. The portable
|
|
# fallback below works on bash 3.2 too.
|
|
# scripts/quality/license-headers.sh
|
|
#
|
|
# Verify that every source file under code/ carries an SPDX-License-
|
|
# Identifier header. The project policy (doc/release-policy.md) is:
|
|
#
|
|
# * Every conformallab++ source file (.h, .hpp, .cpp under code/include
|
|
# or code/src, but NOT code/deps/) must have:
|
|
# SPDX-License-Identifier: MIT
|
|
# * The copyright line is encouraged but not enforced (the year is
|
|
# allowed to lag).
|
|
#
|
|
# Files under code/deps/ are vendored third-party code (Eigen, JSON,
|
|
# GLFW, libigl, …) and are skipped — they carry their own licenses.
|
|
#
|
|
# Exit codes:
|
|
# 0 every checked file has the SPDX header
|
|
# 1 at least one file is missing it
|
|
# 2 prerequisite missing
|
|
#
|
|
# Run from any directory; the script resolves the repo root from its own path.
|
|
|
|
set -euo pipefail
|
|
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
|
cd "$ROOT"
|
|
|
|
SPDX="SPDX-License-Identifier: MIT"
|
|
|
|
# Files to check: code/include + code/src + code/tests. Skip code/deps.
|
|
FILES_LIST="$(find code/include code/src code/tests \
|
|
\( -name "*.h" -o -name "*.hpp" -o -name "*.cpp" \) \
|
|
-type f 2>/dev/null \
|
|
| grep -v "^code/deps/" \
|
|
| grep -v " 2\." \
|
|
| sort)"
|
|
|
|
n_total=0
|
|
n_missing=0
|
|
missing_list=""
|
|
while IFS= read -r f; do
|
|
[ -z "$f" ] && continue
|
|
n_total=$((n_total + 1))
|
|
# Check only the first 30 lines — SPDX must be near the top.
|
|
if ! head -30 "$f" | grep -q "$SPDX"; then
|
|
n_missing=$((n_missing + 1))
|
|
missing_list="$missing_list $f
|
|
"
|
|
fi
|
|
done <<EOF
|
|
$FILES_LIST
|
|
EOF
|
|
|
|
if [ "$n_total" -eq 0 ]; then
|
|
echo "FAIL: no source files found under code/{include,src,tests}/" >&2
|
|
exit 2
|
|
fi
|
|
|
|
echo "Checked $n_total source files for SPDX header."
|
|
|
|
if [ "$n_missing" -gt 0 ]; then
|
|
echo
|
|
echo "FAIL: $n_missing file(s) missing '$SPDX' in their first 30 lines:"
|
|
printf '%s' "$missing_list"
|
|
echo
|
|
echo "Recovery: add this two-line header at the top of each file:"
|
|
echo " // Copyright (c) 2024-$(date +%Y) Tarik Moussa."
|
|
echo " // $SPDX"
|
|
exit 1
|
|
fi
|
|
|
|
echo "OK: every checked file carries '$SPDX'."
|
|
exit 0
|