openml / server-api

Python-based server
https://openml.github.io/server-api/
BSD 3-Clause "New" or "Revised" License
1 stars 1 forks source link

Add code coverage reporting #200

Closed PGijsbers closed 1 week ago

PGijsbers commented 1 week ago

Currently not configured to be blocking, just informative. It is an explicit decision to include coverage of test code.

Summary by Sourcery

Add code coverage reporting to the CI workflow using Codecov, including coverage of test code, and configure it to be non-blocking and informative.

CI:

sourcery-ai[bot] commented 1 week ago

Reviewer's Guide by Sourcery

This pull request adds code coverage reporting to the existing GitHub Actions workflow. It modifies the test execution commands to use the 'coverage' tool and introduces steps to upload the coverage results to Codecov.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Integrate code coverage reporting into the CI pipeline
  • Replace pytest command with coverage run for test execution
  • Add step to generate XML coverage report
  • Introduce Codecov action to upload coverage results
  • Use Codecov token from GitHub secrets for authentication
.github/workflows/tests.yml

Tips and commands #### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).
codecov[bot] commented 1 week ago

Welcome to Codecov :tada:

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 :open_umbrella: