Skip to content

docs: clarify local test binaries vs pre-push Maven verification - #1109

Merged
ColinLeeo merged 2 commits into
developfrom
colin/claude-md-testing
Nov 16, 2026
Merged

ColinLeeo merged 2 commits into
developfrom
colin/claude-md-testing

Conversation

@ColinLeeo

Copy link
Copy Markdown
Contributor

Problem

The repository documents two ways to run tests — the Maven profiles in the root CLAUDE.md and the directly built TsFile_Test binary in cpp/CLAUDE.md — without saying how they differ. Running only the binary is much faster but skips Maven's compile/link/package steps, so failures that only appear in the CI pipeline are missed. A recent example: a constexpr data member without an out-of-class definition linked fine on macOS with the directly built binary but failed under Linux/LTO in CI.

Change

Documentation only:

  • Root CLAUDE.md: new "Local Iteration vs. Pre-Push Verification" section — direct test binary / pytest for fast iteration, Maven profile verification as the smoke check before pushing, and a pointer to the existing "Required Checks Before Pushing" section for the full clean suite and sanitizer runs.
  • cpp/CLAUDE.md and python/CLAUDE.md: annotate their "Run tests" entries as the fast-iteration path and state that pushing requires the Maven entry point CI uses.

No code, scripts or build configuration changed. git diff --check is clean.

Directly built test binaries are the fast iteration path, but CI builds
and tests through Maven, so they miss Maven's compile/link/package steps
(e.g. a missing out-of-class constexpr definition links on macOS but
fails under Linux/LTO). Document both entry points and require the
Maven profile verification before committing or pushing.
The Required Checks section already mandates the clean full Maven
suite; describe the profile commands as smoke checks instead of telling
readers to omit clean.
@ColinLeeo
ColinLeeo merged commit 4b308b9 into develop Nov 16, 2026
46 checks passed
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 66.89%. Comparing base (4ef3102) to head (96adee0).
⚠️ Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #1109   +/-   ##
========================================
  Coverage    66.89%   66.89%           
========================================
  Files          788      788           
  Lines        57630    57630           
  Branches      9310     9310           
========================================
+ Hits         38551    38552    +1     
  Misses       17399    17399           
+ Partials      1680     1679    -1     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants