search

righteouslabs / calltraces

A small package for tracing function calls
MIT License
0 stars 0 forks source link

Extract the code coverage badge from the GitHub workflow #3

Closed rrmistry closed 2 years ago

rrmistry commented 2 years ago

Background

A lot of packages (not just Python but many programming languages) use unit-testing and code-coverage concepts.

This means that a user of the package has the confidence that the code being used is adequately tested and checked before pushing to production.

This information is "distilled" into badges that can be confidently displayed on the top of ReadMe pages.

A good example is the Python tqdm package:

https://pypi.org/project/tqdm/

Image

At the very minimum, we need to add the coverage or codecov badges to our test package.

Requirement

See what is the minimum requirement to have this badge be automatically displayed for new package versions.

Reference: https://stackoverflow.com/questions/64037397/collect-code-coverage-using-github-action

rrmistry commented 2 years ago

Take a look at this and see if we can use Azure DevOps to host code-coverage data: https://docs.microsoft.com/en-us/azure/devops/pipelines/tasks/test/publish-code-coverage-results?view=azure-devops

rrmistry commented 2 years ago

Found the exact documentation you'll need @msuthar09 : https://docs.microsoft.com/en-us/azure/devops/pipelines/ecosystems/python?view=azure-devops#publish-code-coverage-results