review: usability audit v0.10.0 — all 11 findings resolved #34

Merged
user2595 merged 10 commits from review/usability-audit-2026-05-31 into main 2026-05-31 08:32:23 +00:00
4 changed files with 13 additions and 12 deletions
Showing only changes of commit d4ea5fdd2e - Show all commits

View File

@@ -3,11 +3,13 @@ name: C++ Tests
# Trigger keywords in commit message (checked via head_commit.message):
# /test-cgal — full CGAL test suite (277 tests, ~5 min build)
# /quality-gates — license, codespell, shellcheck, CGAL conventions
# /ci-all — all of the above + /docs + /links (across all workflows)
#
# ⚠ /ci-all was removed: the Pi runner (3-4 GB RAM) cannot sustain
# multiple Docker containers simultaneously. Use one keyword per commit.
#
# Examples:
# git commit -m "fix: correct angle formula /test-cgal"
# git commit -m "release prep /ci-all"
# git commit -m "chore: update headers /quality-gates"
#
# test-fast always runs on every push — it is fast (< 5 s) and cheap.
@@ -76,9 +78,7 @@ jobs:
# ─────────────────────────────────────────────────────────────────────────────
test-cgal:
needs: test-fast
if: |
contains(github.event.head_commit.message, '/test-cgal') ||
contains(github.event.head_commit.message, '/ci-all')
if: contains(github.event.head_commit.message, '/test-cgal')
runs-on: eulernest
container:
image: git.eulernest.eu/conformallab/ci-cpp:latest
@@ -133,9 +133,7 @@ jobs:
# Cheap (~30 s): license headers, CGAL conventions, codespell, shellcheck.
# ─────────────────────────────────────────────────────────────────────────────
quality-gates:
if: |
contains(github.event.head_commit.message, '/quality-gates') ||
contains(github.event.head_commit.message, '/ci-all')
if: contains(github.event.head_commit.message, '/quality-gates')
runs-on: eulernest
container:
image: git.eulernest.eu/conformallab/ci-cpp:latest

View File

@@ -27,8 +27,7 @@ jobs:
doc-build:
if: |
github.event_name == 'workflow_dispatch' ||
contains(github.event.head_commit.message, '/docs') ||
contains(github.event.head_commit.message, '/ci-all')
contains(github.event.head_commit.message, '/docs')
runs-on: eulernest
container:
image: git.eulernest.eu/conformallab/ci-cpp:latest

View File

@@ -27,8 +27,7 @@ jobs:
if: |
github.event_name == 'schedule' ||
github.event_name == 'workflow_dispatch' ||
contains(github.event.head_commit.message, '/links') ||
contains(github.event.head_commit.message, '/ci-all')
contains(github.event.head_commit.message, '/links')
runs-on: eulernest
container:
image: git.eulernest.eu/conformallab/ci-cpp:latest

View File

@@ -270,6 +270,11 @@ Three jobs in `.gitea/workflows/cpp-tests.yml`:
| `doc-build` | *(none)* | Doxygen | `/docs` in commit message or `workflow_dispatch` | **active** |
| `markdown-links` | *(none)* | python3 | `/links` in commit message, weekly cron, `workflow_dispatch` | **active** |
> **⚠ Pi runner limit:** use **one keyword per commit**. The Pi (3-4 GB RAM) cannot run
> multiple Docker containers simultaneously. `/ci-all` was removed for this reason.
> Typical workflow: one commit with `/test-cgal`, then if green a separate commit with
> `/quality-gates`.
Runner: `eulernest` — self-hosted Raspberry Pi, ARM64, Ubuntu 22.04. Docker image: `git.eulernest.eu/conformallab/ci-cpp:latest`. `test-cgal` and `quality-gates` both need `test-fast` to pass first (`needs: test-fast`).
`quality-gates` runs four required structural gates: `license-headers.sh`, `cgal-conventions.py`, `codespell.sh`, `shellcheck.sh --strict`. Seven more gates (clang-format, cmake-format, cppcheck, sanitizers, clang-tidy, multi-compiler, reproducible-build) are local-only — see `scripts/quality/README.md`.