Skip to content

ci: Add Code Coverage Badge (via CodeCov)#73

Merged
ebouchut merged 3 commits into
devfrom
docs-link-coverage-reports
Jul 7, 2026
Merged

ci: Add Code Coverage Badge (via CodeCov)#73
ebouchut merged 3 commits into
devfrom
docs-link-coverage-reports

Conversation

@ebouchut

@ebouchut ebouchut commented Jul 7, 2026

Copy link
Copy Markdown
Owner

This PR adds Codecov for coverage reporting, including upload, badges, and documentation updates.

Changes

  • Adopt ADR001: decision to publish coverage to Codecov; mark Codecov statuses informational so will block merges; supersede ADR-0011 and update ADR index.
  • CI:
    • Add Codecov upload step to Tests workflow (pinned codecov-action),
    • Upload JaCoCo reporttarget/site/jacoco/jacoco.xml,
    • Keep workflow-artifact upload as fallback, and upload do fail CI,
    • Use the CODECOV_TOKEN secret when available.
  • Docs:
    • Add Codecov badge and dashboard link to README.
    • Update CONTRIBUTING.md with codecov and PR comment behavior.
    • Add Codecov entries to GLOSSARY.md and GLOSSAIRE.md.
    • Add CI/code quality to docs/-stacks.md.
    • Record dev plan in docs/plans/2026-07-07-codecov-coverage.md.

Note

  • Codecov uploads tokenless (rate-limited) until CODECOV_TOKEN is set in Repository Settings / Secrets and Variables / Actions / Repository Secrets.
  • Codecov and Checkstyle statuses are informative and do not block merges.

ebouchut added 3 commits July 7, 2026 21:30
Add ADR-0012 (publish test coverage to Codecov): a live README badge and PR
coverage feedback are not achievable with workflow artifacts alone, and the
CI-committed badge alternative was rejected because CI must not push
commits. Codecov statuses are configured informational so coverage never
blocks a merge.

ADR-0012 supersedes ADR-0011 and restates its surviving half (Checkstyle
stays advisory). Update ADR-0011's status and the ADR index accordingly.
Add a Codecov upload step to the Tests workflow (codecov-action pinned to
the commit SHA of v7.0.0) sending target/site/jacoco/jacoco.xml, and a root
codecov.yml marking the project and patch statuses informational so
coverage reports never block a merge (ADR-0012). Upload failures do not
fail CI. The workflow-artifact upload stays as an offline fallback.

The upload uses the CODECOV_TOKEN repository secret; until it is set,
uploads from this public repository run tokenless (rate-limited).
Add the Codecov coverage badge to the README badge block, linking to the
dashboard, and rework the documentation entry to lead with Codecov while
keeping the workflow-artifact and local-report paths. Document the Codecov
flow in CONTRIBUTING (dashboard, PR comments, informational statuses), add
Codecov entries to GLOSSARY.md and GLOSSAIRE.md (kept in sync), add a CI
and code quality table to docs/tech-stacks.md (GitHub Actions, Checkstyle,
JaCoCo, Codecov), and record the executed plan in
docs/plans/2026-07-07-codecov-coverage.md.
@ebouchut ebouchut self-assigned this Jul 7, 2026
@ebouchut ebouchut added documentation Improvements or additions to documentation dependencies infrastructure ci Continuous Integration test labels Jul 7, 2026
@codecov

codecov Bot commented Jul 7, 2026

Copy link
Copy Markdown

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.

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

@ebouchut ebouchut added this to the v0.9 - Code Freeze milestone Jul 7, 2026
@ebouchut ebouchut moved this to In Progress in learn-dev-project Jul 7, 2026
@ebouchut ebouchut merged commit b6ca97b into dev Jul 7, 2026
6 checks passed
@ebouchut ebouchut deleted the docs-link-coverage-reports branch July 7, 2026 19:55
@github-project-automation github-project-automation Bot moved this from In Progress to Done in learn-dev-project Jul 7, 2026
@ebouchut ebouchut changed the title Add Code Coverage Badge (via CodeCov) ci: Add Code Coverage Badge (via CodeCov) Jul 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Continuous Integration dependencies documentation Improvements or additions to documentation infrastructure test

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant