aethersdr / aethersdr/AetherSDR

CI never runs bridge_docs_check (every ctest call in ci.yml is -R filtered)

Open
#4,830 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug maintainer-review
Dominant language
C++
Stars
221
Forks
117
Avg merge
2d 7h
Merged PRs (30d)
299

Description

What

bridge_docs_check — the #4174 Phase 3 drift check that asserts docs/automation-bridge.md's generated verb table matches the automation-bridge registry — is registered as a ctest (CMakeLists.txt), but CI never runs it.

Every ctest invocation in .github/workflows/ci.yml is -R-filtered to a handful of named tests, and this one is not among them. A PR that adds a verb without regenerating the docs is green on CI and red locally.

How it surfaced

Caught by hand in review of #4780, which added the notch verb:

$ python3 tools/gen_bridge_docs.py --check
FAIL: docs verb table is STALE (59 verbs in the registry) — run tools/gen_bridge_docs.py

green at the merge base, red on the branch, and CI passed all four checks anyway. Fixed in that PR, but the next verb will hit the same hole.

What to do

Either add bridge_docs_check to the filtered list, or — better — work out which tests the -R filters are actually excluding and why. A drift check that only fails on the reviewer's machine is doing a fraction of its job, and this is the general shape of the problem, not one test's bad luck.

Worth auditing the same way for the other non-GUI, no-hardware checks that are cheap enough to run on every PR.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the ctest invocations in .github/workflows/ci.yml and the bridge_docs_check registration in CMakeLists.txt; run python3 tools/gen_bridge_docs.py --check to understand the drift check. Update the CI test selection or audit the excluded checks so bridge_docs_check runs on pull requests, then verify the relevant CI checks cover it.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake, cpp, github-actions, python
Domain
build-system, ci-cd, testing-qa
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.