Skip to content

Add code coverage support with pytest-cov and Codecov integration#296

Merged
ekzhu merged 2 commits intoekzhu:masterfrom
bhimrazy:add-coverage-support
Dec 30, 2025
Merged

Add code coverage support with pytest-cov and Codecov integration#296
ekzhu merged 2 commits intoekzhu:masterfrom
bhimrazy:add-coverage-support

Conversation

@bhimrazy
Copy link
Copy Markdown
Contributor

@bhimrazy bhimrazy commented Dec 28, 2025

What does this PR do?

  • Adds pytest-cov to test dependencies for code coverage measurement
  • Configures pytest to run with coverage for the datasketch package
  • Updates GitHub Actions workflow to generate and upload coverage reports to Codecov
  • Adds Codecov badge to README.rst
  • Configures coverage to omit experimental and test directories from reports

Setup Instructions for Maintainers

To enable Codecov uploads, the repository maintainer needs to:

  1. Sign up for a Codecov account at https://codecov.io/
  2. Connect the ekzhu/datasketch repository to Codecov
  3. Generate a repository upload token from Codecov dashboard
  4. Add the token as a GitHub secret named CODECOV_TOKEN in the repository settings:

The workflow will automatically upload coverage reports once the secret is configured.
cc: @ekzhu

Checklist

  • Are unit tests passing? (Coverage will be measured in CI)
  • Documentation added/updated for all public APIs? (No API changes)
  • Is this a breaking change? If yes, add "[BREAKING]" to the PR title. (No breaking changes)

- Add pytest-cov to test dependencies
- Configure pytest to run with coverage for datasketch package
- Update GitHub Actions workflow to upload coverage reports to Codecov
- Add Codecov badge to README
- Configure coverage to omit experimental and test directories
@bhimrazy bhimrazy requested a review from ekzhu as a code owner December 28, 2025 07:30
@ekzhu
Copy link
Copy Markdown
Owner

ekzhu commented Dec 30, 2025

@bhimrazy I have finished setting up the repository secret. Thanks.

@codecov-commenter
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 ☂️

@ekzhu ekzhu merged commit 2bf46fa into ekzhu:master Dec 30, 2025
9 checks passed
@bhimrazy bhimrazy deleted the add-coverage-support branch December 30, 2025 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants