ci: add Codecov integration for code coverage tracking by rkmangal23 · Pull Request #406 · docling-project/docling-java

rkmangal23 · 2026-03-19T07:16:33Z

This PR is for adding codeCov to the project. It works with jaCoCo reports. I tested it with push to my fork by changing the condition for prepare test report and used my token in the fork. For parent repo, separate token would need to be added as I see has been requested in the issue.
Have used Bob (IBM's code assistant)to help me in getting this done quickly. And it is listed in the commits with me (my product team has made changes to add a githook for this).

I could see a report like this in codecov.io

Fixes #199

codecov · 2026-03-19T11:49:25Z

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment

Thanks for integrating Codecov - We've got you covered ☂️

github-actions · 2026-03-19T11:50:21Z

:java_duke: JaCoCo coverage report

Overall Project	47.29%	🔴

There is no coverage information present for the Files changed

github-actions · 2026-03-19T11:50:23Z

	Tests	Passed ✅	Skipped	Failed
Gradle Test Results (all modules & JDKs)	1002 ran	1002 passed	0 skipped	0 failed

Test	Result
No test annotations available

View Gradle Test Results (all modules & JDKs)

github-actions · 2026-03-19T11:50:24Z

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

edeandrea

Thanks @rkmangal23 for this! I've added some comments.

Also, I'm just going to re-post from our conversation on slack so that its out in the open.

I know we collect coverage across the entire project as a whole - but do you think it would be better to break out the report per project? It would turn into separate checks and report coverage per project, for which we could then define separate thresholds. See https://docs.codecov.com/docs/commit-status#splitting-up-projects-example

For example:

It would give a single check for the whole project, but also show each individual project's coverage, which could be helpful if we want a quick visualization of where coverage is lacking

.github/workflows/build.yml

codecov.yml

.github/codecov.yml

README.md

codecov.yml

edeandrea · 2026-03-19T13:07:58Z

@all-contributors add @rkmangal23 for code doc ideas tool test infra

allcontributors · 2026-03-19T13:08:09Z

@edeandrea

I've put up a pull request to add @rkmangal23! 🎉

.github/workflows/build.yml

Copilot

Pull request overview

Adds Codecov-based coverage reporting to docling-java by uploading the existing aggregated JaCoCo XML report from CI and exposing coverage status via a README badge, aligning with the broader Docling ecosystem’s Codecov usage (Fixes #199).

Changes:

Add codecov.yml configuration (status checks, flags, ignore rules, comment layout).
Upload aggregated JaCoCo XML coverage reports to Codecov from the GitHub Actions build matrix.
Add a Codecov badge to the project README.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File	Description
`codecov.yml`	Introduces Codecov configuration for project/patch statuses, flags, and ignored paths.
`README.md`	Adds Codecov badge pointing to coverage for the `main` branch.
`.github/workflows/build.yml`	Uploads aggregated JaCoCo XML report to Codecov for each Java version in the matrix.

You can also share your feedback on Copilot code review. Take the survey.

.github/workflows/build.yml

codecov.yml

github-actions · 2026-03-19T13:27:08Z

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

- Add Codecov upload step to build workflow - Create codecov.yml configuration with flags for Java 17, 21, 25 - Add Codecov badge to README - Configure coverage thresholds and ignore patterns Fixes docling-project#199 Co-authored-by: Bob <bob@ibm.com> Signed-off-by: Rohan <rohan.kurian@ibm.com> Signed-off-by: Bob <bob@ibm.com>

- Remove pull_request-only condition - Allows Codecov upload on direct pushes to main - Enables coverage tracking for all commits Co-authored-by: Bob <bob@ibm.com> Signed-off-by: Rohan <rohan.kurian@ibm.com> Signed-off-by: Bob <bob@ibm.com>

- Remove matrix strategy for multiple Java versions - Use only Java 17 for coverage reports - Remove Java version flags from Codecov config - Simplifies coverage tracking and reduces CI time Co-authored-by: Bob <bob@ibm.com> Signed-off-by: Rohan <rohan.kurian@ibm.com> Signed-off-by: Bob <bob@ibm.com>

- Only run coverage reports on pull requests - Reduces unnecessary CI runs on direct pushes to main Co-authored-by: Bob <bob@ibm.com> Signed-off-by: Rohan <rohan.kurian@ibm.com> Signed-off-by: Bob <bob@ibm.com>

- Restore matrix strategy for Java 17, 21, 25 - Add flags to track coverage per Java version - Enables per-version coverage insights in Codecov Co-authored-by: Bob <bob@ibm.com> Signed-off-by: Rohan <rohan.kurian@ibm.com> Signed-off-by: Bob <bob@ibm.com>

github-actions · 2026-03-19T14:09:43Z

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

github-actions · 2026-03-19T14:22:14Z

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

Remove explicit carryforward: false flags since false is the default value. Simplifies configuration by relying on Codecov defaults. Co-authored-by: Bob <bob@codeium.com> Signed-off-by: Rohan <rohan.kurian@ibm.com>

@edeandrea

- Add condition to only run on main repo when token is available - Move CODECOV_TOKEN from env to with.token parameter (preferred by codecov-action v5) - Prevents issues with fork PRs where secrets are unavailable Addresses Copilot feedback validated by @edeandrea in PR docling-project#406 Co-authored-by: Bob <bob@codeium.com> Signed-off-by: Rohan <rohan.kurian@ibm.com>

@edeandrea

- Add condition to only run on main repo when token is available - Move CODECOV_TOKEN from env to with.token parameter (preferred by codecov-action v5) - Prevents issues with fork PRs where secrets are unavailable Addresses Copilot feedback validated by @edeandrea in PR docling-project#406 Co-authored-by: Bob <bob@codeium.com> Signed-off-by: Rohan <rohan.kurian@ibm.com>

Enable prepare-test-reports job to run on both pull_request and push events. This ensures: - Baseline coverage is maintained on main branch - README badge stays current - PR comparisons have accurate base coverage - Historical coverage trends are tracked Implements ChatGPT recommendation and addresses Copilot feedback in PR docling-project#406 Co-authored-by: Bob <bob@codeium.com> Signed-off-by: Rohan <rohan.kurian@ibm.com>

@edeandrea

Configure separate coverage status checks for: - docling-core - docling-serve-api - docling-serve-client This provides granular visibility into coverage for each production module. Excludes docling-testcontainers and docling-testing as they are test infrastructure. Addresses @edeandrea feedback in PR docling-project#406 Co-authored-by: Bob <bob@codeium.com> Signed-off-by: Rohan <rohan.kurian@ibm.com>

@edeandrea

Configure separate coverage status checks for: - docling-core - docling-serve-api - docling-serve-client This provides granular visibility into coverage for each production module. Excludes docling-testcontainers and docling-testing as they are test infrastructure. Addresses @edeandrea feedback in PR docling-project#406 Co-authored-by: Bob <bob@codeium.com> Signed-off-by: Rohan <rohan.kurian@ibm.com>

@edeandrea

Create individual README files for each production module: - docling-core/README.md - docling-serve/docling-serve-api/README.md - docling-serve/docling-serve-client/README.md Each README includes: - Module-specific Codecov badge with flag parameter - Link to detailed coverage reports on Codecov This provides granular coverage visibility as requested by @edeandrea in PR docling-project#406 Co-authored-by: Bob <bob@codeium.com> Signed-off-by: Rohan <rohan.kurian@ibm.com>

@edeandrea

Create individual README files for each production module: - docling-core/README.md - docling-serve/docling-serve-api/README.md - docling-serve/docling-serve-client/README.md Each README includes: - Module-specific Codecov badge with flag parameter - Link to detailed coverage reports on Codecov This provides granular coverage visibility as requested by @edeandrea in PR docling-project#406 Co-authored-by: Bob <bob@codeium.com> Signed-off-by: Rohan <rohan.kurian@ibm.com>

…ecov.yml Signed-off-by: Eric Deandrea <eric.deandrea@ibm.com>

edeandrea · 2026-03-24T19:26:40Z

Thanks @rkmangal23 for this! Once the checks pass I will merge it. We can tune it afterwards if we need to.

… Version Tests Signed-off-by: Eric Deandrea <eric.deandrea@ibm.com>

…199' into rkmangal23-codecov

Signed-off-by: Eric Deandrea <eric.deandrea@ibm.com>

github-actions · 2026-03-25T12:38:33Z

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

rkmangal23 changed the title ~~Adding codecov support - Issue 199~~ feat(devops): add Codecov integration for code coverage tracking Mar 19, 2026

rkmangal23 force-pushed the feature/codecov-integration-199 branch from 6d2e680 to c679802 Compare March 19, 2026 08:22

rkmangal23 changed the title ~~feat(devops): add Codecov integration for code coverage tracking~~ devops: add Codecov integration for code coverage tracking Mar 19, 2026

rkmangal23 changed the title ~~devops: add Codecov integration for code coverage tracking~~ ci: add Codecov integration for code coverage tracking Mar 19, 2026

rkmangal23 closed this Mar 19, 2026

rkmangal23 reopened this Mar 19, 2026

rkmangal23 force-pushed the feature/codecov-integration-199 branch from c679802 to 80b1fc1 Compare March 19, 2026 08:47

rkmangal23 marked this pull request as ready for review March 19, 2026 08:48

edeandrea reviewed Mar 19, 2026

View reviewed changes

allcontributors bot mentioned this pull request Mar 19, 2026

docs: add rkmangal23 as a contributor for code, doc, and 4 more #407

Merged

edeandrea reviewed Mar 19, 2026

View reviewed changes

.github/workflows/build.yml Show resolved Hide resolved

edeandrea requested a review from Copilot March 19, 2026 13:14

edeandrea force-pushed the feature/codecov-integration-199 branch from 80b1fc1 to e83e26c Compare March 19, 2026 13:16

Copilot AI reviewed Mar 19, 2026

View reviewed changes

.github/workflows/build.yml Show resolved Hide resolved

.github/workflows/build.yml Outdated Show resolved Hide resolved

.github/workflows/build.yml Outdated Show resolved Hide resolved

codecov.yml Outdated Show resolved Hide resolved

edeandrea force-pushed the feature/codecov-integration-199 branch from e83e26c to 22c93d1 Compare March 19, 2026 13:51

Rohan added 5 commits March 19, 2026 09:59

ci: run prepare-test-reports on push to main

ac5368b

- Remove pull_request-only condition - Allows Codecov upload on direct pushes to main - Enables coverage tracking for all commits Co-authored-by: Bob <bob@ibm.com> Signed-off-by: Rohan <rohan.kurian@ibm.com> Signed-off-by: Bob <bob@ibm.com>

ci: restore PR-only condition for prepare-test-reports

1087cf4

- Only run coverage reports on pull requests - Reduces unnecessary CI runs on direct pushes to main Co-authored-by: Bob <bob@ibm.com> Signed-off-by: Rohan <rohan.kurian@ibm.com> Signed-off-by: Bob <bob@ibm.com>

edeandrea force-pushed the feature/codecov-integration-199 branch from 22c93d1 to 04f125d Compare March 19, 2026 14:00

Rohan and others added 2 commits March 21, 2026 11:37

refactor: remove unnecessary carryforward flags configuration

94eea2f

Remove explicit carryforward: false flags since false is the default value. Simplifies configuration by relying on Codecov defaults. Co-authored-by: Bob <bob@codeium.com> Signed-off-by: Rohan <rohan.kurian@ibm.com>

rkmangal23 force-pushed the feature/codecov-integration-199 branch from 32dd927 to 1af0c33 Compare March 21, 2026 06:49

rkmangal23 requested a review from edeandrea March 23, 2026 15:31

rkmangal23 and others added 3 commits March 24, 2026 09:51

Merge branch 'main' into feature/codecov-integration-199

2124796

ci: Add new paths for docling-testcontainers and version tests in cod…

45c216f

…ecov.yml Signed-off-by: Eric Deandrea <eric.deandrea@ibm.com>

Merge branch 'main' into feature/codecov-integration-199

fb6b1a6

edeandrea enabled auto-merge (squash) March 24, 2026 19:26

edeandrea previously approved these changes Mar 24, 2026

View reviewed changes

edeandrea disabled auto-merge March 24, 2026 19:30

edeandrea added 2 commits March 24, 2026 15:33

docs: Add coverage sections and Codecov badges for Testcontainers and…

abfcb45

… Version Tests Signed-off-by: Eric Deandrea <eric.deandrea@ibm.com>

Merge remote-tracking branch 'rkmangal23/feature/codecov-integration-…

f9ca2be

…199' into rkmangal23-codecov

edeandrea dismissed their stale review via f9ca2be March 24, 2026 19:33

edeandrea enabled auto-merge (squash) March 24, 2026 19:34

edeandrea previously approved these changes Mar 24, 2026

View reviewed changes

ci: Fix Codecov upload conditional in build workflow

70d999b

Signed-off-by: Eric Deandrea <eric.deandrea@ibm.com>

edeandrea dismissed their stale review via 70d999b March 24, 2026 20:51

edeandrea added 3 commits March 24, 2026 16:53

ci: Fix Codecov upload conditional in build workflow

ca85554

Signed-off-by: Eric Deandrea <eric.deandrea@ibm.com>

chore: trigger CI

49b2f2f

chore: trigger CI

978bb6e

edeandrea merged commit d31b544 into docling-project:main Mar 25, 2026
21 checks passed

Conversation

rkmangal23 commented Mar 19, 2026 • edited by edeandrea Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Mar 19, 2026

Welcome to Codecov 🎉

Uh oh!

github-actions bot commented Mar 19, 2026

:java_duke: JaCoCo coverage report

Uh oh!

github-actions bot commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 19, 2026

Uh oh!

edeandrea left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

edeandrea commented Mar 19, 2026

Uh oh!

allcontributors bot commented Mar 19, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 19, 2026

Uh oh!

github-actions bot commented Mar 19, 2026

Uh oh!

github-actions bot commented Mar 19, 2026

Uh oh!

edeandrea commented Mar 24, 2026

Uh oh!

Uh oh!

github-actions bot commented Mar 25, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rkmangal23 commented Mar 19, 2026 •

edited by edeandrea

Loading

github-actions bot commented Mar 19, 2026 •

edited

Loading