Skip to content

Update requirements on docs #467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 15, 2019

Conversation

MarcoRossignoli
Copy link
Collaborator

@MarcoRossignoli MarcoRossignoli commented Jun 12, 2019

@AArnott
Copy link
Contributor

AArnott commented Jun 12, 2019

The docs look fine, but I don't think this should close #466 because a doc on this README is neither discoverable nor alleviates the fault-looking error when the test run fails.

IMO we need to update docs where users look. Personally, the docs I was basing my work on were here: https://aka.ms/vstest-collect. They don't even mention coverlet, but apparently coverlet is an implementation detail of how code coverage is collected. Can/should we get those docs updated to indicate the restriction?

Also, can we produce a better error than the one mentioned in #466 to educate the user as to what they should do?

This limitation required that I break up my otherwise monolithic dotnet test command into individual dotnet test -f TFM1 commands (6 of them, I think) just so I could avoid adding the code coverage switch to the netcoreapp1.x targeted test target frameworks. I'd rather keep just the one command in my Azure Pipeline and have the non-supporting targets emit a warning to the effect of "coverage won't be collected on .NET Core 1.x" but otherwise let the tests run their course.

@MarcoRossignoli
Copy link
Collaborator Author

MarcoRossignoli commented Jun 12, 2019

The docs look fine, but I don't think this should close #466 because a doc on this README is neither discoverable nor alleviates the fault-looking error when the test run fails.

I understood that issue was to only update our side with the info.

IMO we need to update docs where users look. Personally, the docs I was basing my work on were here: https://aka.ms/vstest-collect. They don't even mention coverlet, but apparently coverlet is an implementation detail of how code coverage is collected. Can/should we get those docs updated to indicate the restriction?

Should be keep updated by coverlet dev members? cc: @vagisha-nidhi @cltshivash @PBoraMSFT

Also, can we produce a better error than the one mentioned in #466 to educate the user as to what they should do?
This limitation required that I break up my otherwise monolithic dotnet test command into individual dotnet test -f TFM1 commands (6 of them, I think) just so I could avoid adding the code coverage switch to the netcoreapp1.x targeted test target frameworks. I'd rather keep just the one command in my Azure Pipeline and have the non-supporting targets emit a warning to the effect of "coverage won't be collected on .NET Core 1.x" but otherwise let the tests run their course.

I agree

@tonerdo tonerdo merged commit 82a22af into coverlet-coverage:master Jun 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants