Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
OmarAlJarrah merged 2 commits into from
Jul 20, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1761346
docs: correct the Kover coverage floor claims from 80% to the real pe…
OmarAlJarrah Jul 18, 2026
1294a0c
docs: restore dropped tee/grep pipefail note in the coverage-floor CI…
OmarAlJarrah Jul 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,9 @@ jobs:
key: ${{ runner.os }}-configcache-gate-${{ hashFiles('**/*.gradle.kts', 'gradle.properties', 'gradle/libs.versions.toml', 'gradle/wrapper/gradle-wrapper.properties') }}
restore-keys: ${{ runner.os }}-configcache-gate-
- name: ktlint, detekt, and JVM coverage floor
# koverVerify pulls in jvmTest and enforces the 80% line-coverage rule. Piped through
# koverVerify pulls in jvmTest and enforces each module's line/branch floors: kuri and
# kuri-bind at 99% line / 85% and 88% branch respectively, kuri-serde-kotlinx at 90%
# line / 80% branch (see each module's build.gradle.kts kover block). Piped through
# tee/grep (pipefail is on by default for `shell: bash`, so a gradlew failure still
# fails the step) to surface Gradle's own configuration-cache hit/miss line in the job
# summary — otherwise confirming the cache above is doing anything means digging
Expand Down
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<a href="https://kotlinlang.org"><img alt="Kotlin" src="https://img.shields.io/badge/kotlin-2.4.0-7F52FF.svg?logo=kotlin&logoColor=white"></a>
<img alt="Kotlin Multiplatform" src="https://img.shields.io/badge/kotlin-multiplatform-7F52FF.svg?logo=kotlin&logoColor=white">
<img alt="JDK" src="https://img.shields.io/badge/JDK-8%2B-437291.svg?logo=openjdk&logoColor=white">
<img alt="Coverage" src="https://img.shields.io/badge/coverage-%E2%89%A580%25-success.svg">
<img alt="Coverage" src="https://img.shields.io/badge/coverage-%E2%89%A590%25-success.svg">
</p>

## Contents
Expand Down Expand Up @@ -592,7 +592,8 @@ Building kuri requires a JDK 21 toolchain; the bundled Gradle wrapper provisions
- Kotlin `allWarningsAsErrors`
- explicit-API strict mode
- the binary-compatibility validator (`apiCheck`)
- an 80% Kover line-coverage floor
- per-module Kover line/branch floors: `kuri` and `kuri-bind` at 99% line / 85% and 88% branch
respectively, `kuri-serde-kotlinx` at 90% line / 80% branch

After an intentional public-API change, regenerate and commit the API snapshot in the same change:

Expand Down