From f98318eee14fd009b924f7e3223301ec8f0457aa Mon Sep 17 00:00:00 2001 From: Eric Bouchut Date: Tue, 7 Jul 2026 16:25:01 +0200 Subject: [PATCH] docs: Link the JaCoCo coverage reports from README and CONTRIBUTING Add a Test Coverage Report subsection to the Running Tests section of CONTRIBUTING.md explaining where the JaCoCo report lands locally (target/site/jacoco/index.html after make test) and on CI (the jacoco-coverage-report artifact of each Tests workflow run), and reference it from the README documentation list. --- CONTRIBUTING.md | 16 ++++++++++++++++ README.md | 4 ++++ 2 files changed, 20 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6eb938e..95e1512 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -899,6 +899,22 @@ Make sure the Podman machine is started first: `podman machine start`. On real Docker (for example in CI) neither variable is needed; `make test` falls back to a plain `./mvnw test`. +#### Test Coverage Report (JaCoCo) + +Every test run measures code coverage with [JaCoCo](https://www.jacoco.org/jacoco/) +(see [ADR-0011](docs/adr/0011-start-ci-quality-checks-as-advisory-reports.md): +coverage is reported, not yet enforced as a threshold). + +- **Locally**: `make test` (or `./mvnw test`) writes the report to + `target/site/jacoco/index.html`. Open it in a browser: + ```bash + open target/site/jacoco/index.html # macOS + ``` +- **On CI**: every [Tests workflow run](https://github.com/ebouchut/learn-dev/actions/workflows/test.yml) + uploads the report as the **`jacoco-coverage-report`** artifact. + Open a run, scroll to its **Artifacts** section, download the archive, + and open `index.html` inside it. + ### Generating the Documentation diff --git a/README.md b/README.md index ba5b3c8..c90d64e 100644 --- a/README.md +++ b/README.md @@ -378,6 +378,10 @@ visit [this link](https://github.com/users/ebouchut/projects/7/views/3). - [GLOSSARY.md](GLOSSARY.md) — definitions of the domain and technical terms used across the project (🇫🇷 French version: [GLOSSAIRE.md](GLOSSAIRE.md)). - [Architecture Decision Records](docs/adr/README.md) — A list of design decisions and their trade-offs. +- [Test coverage reports (JaCoCo)](https://github.com/ebouchut/learn-dev/actions/workflows/test.yml) — + published as the `jacoco-coverage-report` artifact of each Tests workflow run; + locally, `make test` writes the same report to `target/site/jacoco/index.html` + (see [CONTRIBUTING](CONTRIBUTING.md#test-coverage-report-jacoco) for details). ## Contributing