Coverage Reports (Beta)

Track code coverage trends over time with LCOV report uploads.

🚧

Beta Feature

Coverage tracking is currently in beta. Please share feedback as you try it out.

Gaffer can track your code coverage metrics alongside your test results. Upload coverage reports to see coverage trends, identify gaps, and monitor improvements over time.

Supported Formats

Format Status File Extension
LCOV Supported lcov.info, .lcov
Cobertura XML Supported coverage.xml, cobertura.xml
JaCoCo XML Supported jacoco.xml
Clover XML Supported clover.xml

Upload API

Use the standard Upload API to send coverage files. The only difference is the file type being uploaded.

Field Required Description
files Yes Your coverage file (e.g., coverage/lcov.info, coverage.xml)
tags.commitSha Recommended Git commit SHA for tracking coverage per commit
tags.branch Recommended Git branch name for filtering coverage by branch
tags.type Optional Set to "coverage" for clarity

Example Request

curl