Skip to content

docs: de-duplicate test counts; drop CI test-count badge - #14

Closed
rigazilla wants to merge 1 commit into
infinispan:mainfrom
rigazilla:feat/test-count-badge
Closed

rigazilla wants to merge 1 commit into
infinispan:mainfrom
rigazilla:feat/test-count-badge

Conversation

@rigazilla

@rigazilla rigazilla commented Oct 9, 2026 •

Copy link
Copy Markdown
Member

Closes #13.

Why

Test counts were hand-maintained in ~6 places across README.md and docs/STATUS.md with nothing verifying them, so they had drifted (a README spot still read "223 unit tests").

What changed — and a change of direction

This PR originally published the counts as a CI-generated shields.io badge (a count_tests.sh helper plus an orphan badges branch force-pushed from CI). That approach was prototyped and then rejected as overkill for a solo, intermittently-worked repo: it added a CI step with contents: write, an orphan branch, a helper script, and a badge that 404s until the first post-merge run and lags CDN caching — a lot of moving parts to avoid typing a number.

Instead, the PR now simply removes the duplication:

  • docs/STATUS.md (the authoritative current-state doc) carries the totals once — 250 unit / 92 integration / 19 suites.
  • README.md drops all hard counts (the ### Unit Tests / ### Integration Tests headings, the "Test Results" block, the directory-tree comments) and defers to STATUS.md.
  • docs/DECISIONS.md records the badge as considered-and-rejected, and notes --gtest_list_tests on the built binaries as the quick way to refresh the single count when it drifts.

No CI, script, or workflow changes remain — .github/workflows/build.yml is back to its main state and scripts/count_tests.sh is gone.

Verification

  • Counts read from the built binaries (unit_tests + the ctest integration-labelled suites via --gtest_list_tests): 250 92 19.

🤖 Generated with Claude Code

@rigazilla
rigazilla force-pushed the feat/test-count-badge branch from 1d2f5f4 to d71b5a3 Compare October 9, 2026 15:18
The test counts were hand-typed in ~6 places across README.md and
docs/STATUS.md and had already drifted. A CI-published shields.io badge
(count_tests.sh + an orphan 'badges' branch force-pushed from CI) was
prototyped to fix this, but is overkill for a solo, intermittently-worked
repo.

Instead, just remove the duplication: docs/STATUS.md (authoritative
current-state doc) carries the totals once; README and the directory tree
describe what is covered and defer to STATUS.md. Removes the CI badge step,
scripts/count_tests.sh, and the README badges. DECISIONS.md records the
badge as considered-and-rejected.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@rigazilla
rigazilla force-pushed the feat/test-count-badge branch from d71b5a3 to 39de3df Compare October 12, 2026 13:53
@rigazilla rigazilla changed the title ci: publish CI-generated test-count badge; stop hand-typing counts docs: de-duplicate test counts; drop CI test-count badge Oct 12, 2026
rigazilla added a commit that referenced this pull request Oct 19, 2026
… convention

STATUS.md trimmed to current-state-only (per AGENTS.md/WORKFLOW.md):
- ⏭ Next steps rebuilt as a clean 1–3 (Step 12 / benchmark / cleanup) + a
  one-line "recently shipped" pointer; dropped the completed-work narrative pile
  and fixed the broken numbering.
- Backlog reduced to open [ ] items only; completed [x] blocks removed (they live
  in "Working and shipped" + dated DECISIONS entries).
- Removed the ~88-line Step-10 implementation plan (shipped work); its schema-bug
  gotcha was preserved in DECISIONS.md first.
- Refreshed stale date stamps (2026-09-16 / 2026-10-09 → 2026-10-19) and stale
  phrasings ("all four operations"; ops table).

Adopt PR #14's convention (imported here; PR #14 closed unmerged as stale):
- Test counts live once, in STATUS.md "Test status" (250 unit / 96 integration /
  20 suites, read via --gtest_list_tests). README drops all hard counts and points
  to STATUS for the breakdown.
- Imported PR #14's "stop repeating test counts" DECISIONS entry (dated 2026-10-09,
  placed chronologically) with a provenance note.

DECISIONS.md: fixed the one non-date heading (multiplexing landing → 2026-07-02,
per commit 5b35248); preserved the replace_if_unmodified nibble-flip schema gotcha.

README.md: Current Progress / milestone footer now include multi-server seed list
(#12); test-count strings removed per the convention above.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@rigazilla

Copy link
Copy Markdown
Member Author

Closing unmerged — superseded. This PR had gone stale/conflicting against main (it was based on the 223/89/18 era).

Its decision and convention have been re-applied on the feat/multi-seed branch (PR #16):

  • Test counts now live once, in docs/STATUS.md "Test status" (250 unit / 96 integration / 20 suites, read via --gtest_list_tests); README.md drops all hard counts and points to STATUS.
  • This PR's "stop repeating test counts (CI badge considered, rejected)" DECISIONS.md entry was imported verbatim (dated 2026-10-09, with a provenance note crediting this PR).

Nothing here is lost — see PR #16.

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.

Keep README test counts in sync via a CI-published badge

1 participant