MSTest SDK document limitations #43717
Conversation
Co-authored-by: Youssef Victor <[email protected]>
Co-authored-by: Youssef Victor <[email protected]>
|
@IEvangelist ready for review |
Co-authored-by: Jakub Jareš <[email protected]>
| @@ -254,6 +254,14 @@ Here's an example update when using the `DotNetCoreCLI` task in Azure DevOps: | |||
| + arguments: '--configuration Release -p:TestingPlatformCommandLineArguments="--report-trx --results-directory $(Agent.TempDirectory) --coverage"' | |||
| ``` | |||
|
|
|||
| ## Known limitations | |||
|
|
|||
| The MSTest SDK has limited integration with NuGet, meaning that the usual NuGet update and Visual Studio UI for managing NuGet packages **DOES NOT** work as expected. See this issue for more details: [NuGet#13127](https://github.com/NuGet/Home/issues/13127). | |||
There was a problem hiding this comment.
If someone is here viewing this section, which is Known limitations, it's not really beneficial to try and use CAPS to emphasize something that is a known limitation. Someone taking the time to read this paragraph will understand the context. It's not hidden in a sea of paragraphs and tables, it's the first thing mentioned. If anything, I would use this instead:
| The MSTest SDK has limited integration with NuGet, meaning that the usual NuGet update and Visual Studio UI for managing NuGet packages **DOES NOT** work as expected. See this issue for more details: [NuGet#13127](https://github.com/NuGet/Home/issues/13127). | |
| The MSTest SDK has limited integration with NuGet, meaning that the usual NuGet update and Visual Studio UI for managing NuGet packages **doesn't** work as expected. See this issue for more details: [NuGet#13127](https://github.com/NuGet/Home/issues/13127). |
But honestly this isn't very clear about the limitation. As a user, I don't want to have to go click on a link and read through comment-after-comment to understand the limitation. Just tell me the limitation and what I need to do to work around it.
There was a problem hiding this comment.
@adegeo Could you please suggest a wording. Basically, NuGet integration is busted so you cannot use VS/VSCode or NuGet CLIs to manage the update of the package and will instead need to do it manually or rely on dependabot.
There was a problem hiding this comment.
@Evangelink Sorry for the delay, I was out sick. If you understand the problem/limitation, can you reiterate it here in a response to myself? I'll take that info and provide a suggestion.
There was a problem hiding this comment.
No worries. As I was saying in the previous comment, the limitation is that you cannot use existing tooling to install or update the SDK package (VS nuget package manager won't work, dotnet nuget won't work...). You have to update manually or rely on dependabot.
This problem is not limited to MSTest but is true for any custom MSBuild sdk
There was a problem hiding this comment.
The dependabot suggestion seems confusing. I don't know how someone would use dependabot, I thought that was just a github thing? Like if I send a copy of my project to a friend through email, what does he do to restore the packages and run the project? How does he actually manually install the required SDK files?
Summary
Fixes microsoft/testfx#4114
Internal previews