Skip to content

docs: correct the Kover coverage floor claims from 80% to the real numbers - #139

Merged
OmarAlJarrah merged 2 commits into
mainfrom
e1-coverage-floor
Jul 20, 2026
Merged

docs: correct the Kover coverage floor claims from 80% to the real numbers#139
OmarAlJarrah merged 2 commits into
mainfrom
e1-coverage-floor

Conversation

@OmarAlJarrah

Copy link
Copy Markdown
Member

Summary

  • The CI workflow comment and the README (badge + "Building from source" prose) all claimed a flat 80% Kover line-coverage floor. No module actually enforces that: kuri and kuri-bind both require 99% line coverage (85% and 88% branch respectively), and kuri-serde-kotlinx requires 90% line / 80% branch, per each module's kover { reports { verify } } block.
  • Updated the CI comment and README to state the real per-module line and branch floors, and moved the README badge from >=80% to >=90% (the true floor across all three modules, since it can only show one number).
  • site/src/content/docs/guides/building-from-source.mdx repeats the same wrong figure, but that file only exists on the still-unmerged docs/astro-site branch (PR feat: add a documentation site (Astro + Starlight) #81), not on main, so it isn't part of this diff — I pushed the equivalent fix directly onto that branch so the correct numbers land whenever feat: add a documentation site (Astro + Starlight) #81 merges.

Test plan

  • Doc-only change (YAML comment + README prose/badge) — no logic touched, proofread the diff for accuracy against each module's build.gradle.kts kover block (kuri/build.gradle.kts:226-227, kuri-bind/build.gradle.kts:94-95, kuri-serde-kotlinx/build.gradle.kts:86-87).

Closes #91

…r-module numbers

The CI comment and README both claimed a flat 80% line-coverage floor, but
kover { reports { verify } } in each module's build.gradle.kts sets different,
higher floors: kuri and kuri-bind require 99% line coverage (85% and 88%
branch respectively), and kuri-serde-kotlinx requires 90% line / 80% branch.
80% never appears in any module's Kover config, so the documented number was
simply wrong and could mislead a contributor into expecting a build to pass
well below what koverVerify actually enforces.

Closes #91
… comment

The coverage-floor comment rewrite accidentally deleted the clause explaining
why the gradlew invocation is piped through tee/grep, leaving a broken fragment
("Piped through fails the step)") with a dangling parenthesis. Restore the
"tee/grep (pipefail is on by default ..." line so the comment reads coherently
again.
@OmarAlJarrah
OmarAlJarrah merged commit 94ffc2f into main Jul 20, 2026
13 checks passed
@OmarAlJarrah
OmarAlJarrah deleted the e1-coverage-floor branch July 20, 2026 17:36
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.

docs: 80% Kover coverage floor is claimed in five places but the real per-module floors are 99% / 99% / 90%

1 participant