feat: add --srcdir option #306
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Together with --basedir option, this feature allows to fix paths of reported files so coveralls.io is able to find the source at GitHub.
TheKevJames
approved these changes
Jul 20, 2021
There was a problem hiding this comment.
@i386x thanks for the contribution! I appreciate the in-depth description; that use-case makes perfect sense to me.
Your implementation LGTM, I'll get this released as soon as I can!
andy-maier
pushed a commit
to andy-maier/coveralls-python
that referenced
this pull request
Dec 23, 2022
Together with --basedir option, this feature allows to fix paths of reported files so coveralls.io is able to find the source at GitHub.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When the repository of Python project on GitHub has the structure
and CI runs
toxwheretox.inihas setusedevelop = falseand it runs tests withpytest --cov=myproject --cov-report=term-missing tests, wheremyprojectrefers tomyprojectpackage build and installed bytox, the coverage report will look like this:The
.tox/py36/lib/python3.6/site-packagescan be stripped by recently introduced--basediroption. This pull request introduces--srcdiroption that specify the package source directory after--basediroption is applied. With this feature, coveralls.io is able to display the content of project files correctly. To demonstrate it:reports the above coverage report to coveralls.io, but since
.tox/py36/lib/python3.6/site-packages/myproject/__init__.pyis not a valid path on GitHub, coveralls.io displays no coverage details for__init__.py. Running the coveralls asdo the trick and the coverage details for
__init__.pyare visible in coveralls.io web UI, sincesrc/myproject/__init__.pyis an existing path on GitHub repository.