Update VSTest docs: fix archived cross-links, add runsettings CLI override and logger catalog#11396
Update VSTest docs: fix archived cross-links, add runsettings CLI override and logger catalog#11396azat-msft wants to merge 5 commits into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4e840b63-ad95-40c2-9ef8-5f2fcc4cfdaa
Cross-reference microsoft/vstest report.md for the full list of built-in and community test loggers and instructions for authoring a logger. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4e840b63-ad95-40c2-9ef8-5f2fcc4cfdaa
The command-line override section is introduced with vstest.console.exe but used dotnet test examples. vstest.console.exe supports the same -- name=value inline runsettings override natively (CliRunSettingsArgumentProcessor), so show the vstest.console.exe form to match the page's context, and note dotnet test uses the same syntax. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4e840b63-ad95-40c2-9ef8-5f2fcc4cfdaa
|
@azat-msft : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. @Mikejo5000 |
|
@azat-msft : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. @Mikejo5000 |
|
Learn Build status updates of commit b7ccf26: ✅ Validation status: passed
For more details, please refer to the build report. |
There was a problem hiding this comment.
Pull request overview
This PR updates Visual Studio VSTest documentation to (1) replace cross-references that pointed to the archived microsoft/vstest-docs repository with links to the maintained microsoft/vstest repository, and (2) document how to override .runsettings values from the command line.
Changes:
- Updated GitHub cross-links for TestCase filter, blame data collector, and data collection docs to reference
microsoft/vstest. - Added a pointer to the upstream logger catalog / logger authoring guidance.
- Added a new section describing command-line runsettings overrides (including
TestRunParameters) and shell quoting considerations.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/test/vstest-console-options.md | Updates archived GitHub cross-links and adds a new logger-catalog pointer. |
| docs/test/configure-unit-tests-by-using-a-dot-runsettings-file.md | Adds command-line runsettings override guidance and a reference to upstream quoting examples. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
Can you review the proposed changes? Important: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
prmerger-automator
Bot
added
the
aq-pr-triaged
|
Learn Build status updates of commit bc282e7: ✅ Validation status: passed
For more details, please refer to the build report. |
BillWagner
left a comment
BillWagner
left a comment
There was a problem hiding this comment.
There's a bit more work here before this is ready.
Also, tagging @RoseHJM for review
| vstest.console.exe test.dll -- TestRunParameters.Parameter(name="myParam", value="value") | ||
| ``` | ||
|
|
||
| Shell quoting rules differ. In Command Prompt, escape quotation marks as needed. In PowerShell 7.3 and later, native command argument handling supports this syntax more directly; in earlier PowerShell versions, or when `$PSNativeCommandArgumentPassing` is set to `legacy`, use the `--%` stop-parsing token. In Bash, escape characters such as parentheses, quotation marks, spaces, and semicolons. |
There was a problem hiding this comment.
This paragraph should also include the rules for unix shells, using zsh as the example.
There was a problem hiding this comment.
added a paragraph covering unix shell quoting with zsh
Address PR review feedback: document unix shell (zsh) escaping rules for the `TestRunParameters.Parameter(...)` override syntax, using zsh as the macOS default-shell example. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 0cc38362-9c3b-46eb-8142-9c49c63dc4a0
|
Learn Build status updates of commit 04ba0c2: ✅ Validation status: passed
For more details, please refer to the build report. |
|
@BillWagner Could you review this proposed update to your article and enter Thanks! |
|
Superseded by #11401, which carries all of this PR's changes (archived-link fixes, runsettings CLI override + zsh quoting, logger catalog pointer) and expands the VSTest doc work into a single coherent change: a new exit-codes section, command-line filter/shell escaping, blame crash/hang dump coverage, and CLI option gaps in \�stest-console-options.md, plus the remaining archived \�stest-docs\ links repointed to \microsoft/vstest. Consolidating here to avoid parallel edits to the same files. Closing in favor of #11401. |
Enrichment of the VSTest documentation on Microsoft Learn (VS docs test area), reconciled against the maintained microsoft/vstest repository.
Files
docs/test/vstest-console-options.md— update cross-reference links that pointed at the archivedmicrosoft/vstest-docsrepo to the maintainedmicrosoft/vstestrepo (filter, blame data collector, analyze), and add a pointer to the full logger catalog + logger-authoring guide.docs/test/configure-unit-tests-by-using-a-dot-runsettings-file.md— add an "Override run settings from the command line" section covering the-- name=valueinline override syntax,TestRunParametersvia the command line, and shell-specific quoting. Examples usevstest.console.exe(the page's context; the-- name=valueoverride is a nativevstest.console.exefeature viaCliRunSettingsArgumentProcessor), with a note thatdotnet testuses the same syntax.Opened from a fork; happy to adjust to match the docs team's conventions.