Skip to content
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

MSTest SDK document limitations #43717

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Evangelink
Copy link
Member

@Evangelink Evangelink commented Nov 22, 2024

Summary

Fixes microsoft/testfx#4114


Internal previews

📄 File 🔗 Preview link
docs/core/testing/unit-testing-mstest-sdk.md MSTest SDK overview

@Evangelink
Copy link
Member Author

@IEvangelist ready for review

@@ -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).
Copy link
Contributor

@adegeo adegeo Nov 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Suggested change
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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

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.

Document downside/limitations of MSTest.Sdk
4 participants