Uh oh!
There was an error while loading. Please reload this page.
Audit MTP CLI options and environment variables; annotate with introduction versions - #54106
Conversation
Inventoried every CommandLineOptionsProvider and EnvironmentVariableConstants entry in microsoft/testfx and reconciled the docs. - cli-options: replace removed --debug-wait-attach with --debug (microsoft/testfx#6516); add --filter-uid, --treenode-filter, --no-banner; clarify --list-tests text|json argument. - config: rename diagnostic env vars to current names (TESTINGPLATFORM_DIAGNOSTIC_FILE_PREFIX, TESTINGPLATFORM_DIAGNOSTIC_SYNCHRONOUS_WRITE) with back-compat notes; add TESTINGPLATFORM_NOBANNER, DOTNET_NOLOGO, TESTINGPLATFORM_WAIT_ATTACH_DEBUGGER, TESTINGPLATFORM_LAUNCH_ATTACH_DEBUGGER. - troubleshooting: sync diagnostic env vars table with renames. - crash-hang-dumps: add --crash-report, --crash-report-if-supported, --crash-sequence, --hangdump-type-if-supported; expand --hangdump-type (TFM-specific values + None), --hangdump-timeout formats and --hangdump-filename placeholders. - terminal-output: add --ansi, --show-stdout, --show-stderr. - test-reports: add all Azure DevOps options (--report-azdo-flaky-history, --report-azdo-demote-known-flaky, --report-azdo-quarantine-file, --report-azdo-upload-artifacts plus -include/-exclude/-name, --publish-azdo-test-results, --publish-azdo-run-name). - retry: add --retry-failed-tests-delay. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Adds 'Available in MTP starting with version X.Y.Z.' notes for every recently added option/env var, so readers can tell at a glance which MTP release to target. Versions referenced: - 1.6.0: TESTINGPLATFORM_WAIT_ATTACH_DEBUGGER, TESTINGPLATFORM_LAUNCH_ATTACH_DEBUGGER - 1.8.0: --filter-uid - 1.9.0: --debug (replacing the 1.6.0 --debug-wait-attach), Azure DevOps extension stable (--report-azdo, --report-azdo-severity) - 2.1.0: --hangdump-type 'None' value - 2.2.1: --show-stdout, --show-stderr - 2.3.0: --list-tests json output, --ansi, --crash-report, --crash-report-if-supported, --crash-sequence, --hangdump-type-if-supported, --retry-failed-tests-delay, all Azure DevOps options beyond report-azdo/severity, TESTINGPLATFORM_DIAGNOSTIC_FILE_PREFIX, TESTINGPLATFORM_DIAGNOSTIC_SYNCHRONOUS_WRITE Also corrects an inaccurate note on --debug: the option was introduced in 1.9.0 (not 'before 2.0'). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR audits and updates the Microsoft.Testing.Platform (MTP) documentation under docs/core/testing/ to reflect current CLI options and environment variables, and it annotates newer additions with “introduced in” version notes so readers can match options to MTP releases.
Changes:
- Updates/expands MTP option and environment-variable references (including renamed variables and new switches) across the testing docs set.
- Adds version-introduction notes (for example, MTP 2.3.0) for recently introduced options and environment variables.
- Refreshes the reference pages for Azure DevOps reporting, terminal output, retry behavior, and crash/hang dump collection.
Show a summary per file
| File | Description |
|---|---|
| docs/core/testing/microsoft-testing-platform-troubleshooting.md | Updates diagnostic environment variable names and adds back-compat/version notes. |
| docs/core/testing/microsoft-testing-platform-test-reports.md | Expands Azure DevOps reporting options and adds a version availability note. |
| docs/core/testing/microsoft-testing-platform-terminal-output.md | Documents additional output-related switches (--ansi, --show-stdout, --show-stderr) with version notes. |
| docs/core/testing/microsoft-testing-platform-retry.md | Documents --retry-failed-tests-delay and clarifies option prerequisites. |
| docs/core/testing/microsoft-testing-platform-crash-hang-dumps.md | Adds crash-reporting-related options and expands hang dump option details. |
| docs/core/testing/microsoft-testing-platform-config.md | Renames diagnostic env vars to current names with deprecation/back-compat notes; adds banner and debugger-related variables. |
| docs/core/testing/microsoft-testing-platform-cli-options.md | Updates/extends platform CLI option reference (for example, --debug, --filter-uid, --no-banner, --list-tests format note). |
Copilot's findings
- Files reviewed: 7/7 changed files
- Comments generated: 16
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
- Drop 'silently' from --crash-report-if-supported and --hangdump-type-if-supported descriptions: the option emits an informational message, so the behavior isn't silent (Copilot comment).
- Apply Oxford commas to remaining value/placeholder lists in --crashdump-type, --crash-sequence, --hangdump-filename, --hangdump-type, and --hangdump-type-if-supported for consistency.
- Tighten --crashdump-type wording ('Defaults to', Oxford comma in value list).
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>Uh oh!
There was an error while loading. Please reload this page.
Summary
Audits every Microsoft.Testing.Platform (MTP)
CommandLineOptionsProviderandEnvironmentVariableConstantsentry in microsoft/testfx and reconciles the docs indocs/core/testing/. Also adds introduction-version annotations so readers can tell at a glance which MTP release each option/env var requires.Motivation: the recent rename
--debug-wait-attach→--debug(microsoft/testfx#6516) was not reflected in the docs, and several options/env vars added through 2025/2026 had never been documented.Changes per file
microsoft-testing-platform-cli-options.md--debug-wait-attachwith--debug(MTP 1.9.0; PRs #6499, #6516). Fixed prior note that incorrectly said "before MTP 2.0".--filter-uid(MTP 1.8.0; PR #6002).--treenode-filterand--no-banner(long-standing, no version annotation).--list-testsacceptstext/json; noted thatjsonrequires MTP 2.3.0 (PR #8280).microsoft-testing-platform-config.mdTESTINGPLATFORM_DIAGNOSTIC_OUTPUT_FILEPREFIX→TESTINGPLATFORM_DIAGNOSTIC_FILE_PREFIXTESTINGPLATFORM_DIAGNOSTIC_FILELOGGER_SYNCHRONOUSWRITE→TESTINGPLATFORM_DIAGNOSTIC_SYNCHRONOUS_WRITETESTINGPLATFORM_NOBANNER,DOTNET_NOLOGO.TESTINGPLATFORM_WAIT_ATTACH_DEBUGGERandTESTINGPLATFORM_LAUNCH_ATTACH_DEBUGGER(MTP 1.6.0; PR #4829).microsoft-testing-platform-troubleshooting.mdmicrosoft-testing-platform-crash-hang-dumps.md--crash-report(PR #8191),--crash-report-if-supported(PR #8666),--crash-sequence(PR #8526) — all MTP 2.3.0.--hangdump-type-if-supported(MTP 2.3.0; PR #8666); expanded--hangdump-typeto note .NET (Core) vs .NET Framework valid values, includingNone(MTP 2.1.0; PR #7213); expanded--hangdump-timeoutformats and--hangdump-filenameplaceholders.microsoft-testing-platform-terminal-output.md--ansi(MTP 2.3.0; PR #8493).--show-stdoutand--show-stderr(MTP 2.2.1; PR #7637).microsoft-testing-platform-test-reports.md--report-azdo-flaky-history,--report-azdo-demote-known-flaky,--report-azdo-quarantine-file(PR #8298);--report-azdo-upload-artifacts,--report-azdo-upload-artifact-include,--report-azdo-upload-artifact-exclude,--report-azdo-upload-artifact-name(PR #8295);--publish-azdo-test-results,--publish-azdo-run-name(PR #8297).microsoft-testing-platform-retry.md--retry-failed-tests-delay(MTP 2.3.0; PR #7840).Skipped (intentional)
Microsoft.Testing.Extensions.HtmlReport(--report-html/--report-html-filename): no published NuGet release.--internal-testingplatform-skipbuildercheck,--internal-testhostcontroller-pid,--server,--client-port,--client-host, etc.).Validation
npx markdownlint-cli2✓ (0 errors on all 7 files).AI usage disclosure
Generated with the assistance of GitHub Copilot CLI. All edited files include
ai-usage: ai-assistedin their frontmatter.Internal previews