Audit MTP CLI options and environment variables; annotate with introduction versions - #54106

Merged
Evangelink merged 4 commits into
dotnet:mainfrom
Evangelink:dev/amauryleve/mtp-cli-env-vars-audit
Jun 2, 2026
Merged

Audit MTP CLI options and environment variables; annotate with introduction versions#54106
Evangelink merged 4 commits into
dotnet:mainfrom
Evangelink:dev/amauryleve/mtp-cli-env-vars-audit

Conversation

@Evangelink

@EvangelinkEvangelink commented Jun 1, 2026

Copy link
Copy Markdown
Member

Summary

Audits every Microsoft.Testing.Platform (MTP) CommandLineOptionsProvider and EnvironmentVariableConstants entry in microsoft/testfx and reconciles the docs in docs/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

  • Replaced removed --debug-wait-attach with --debug (MTP 1.9.0; PRs #6499, #6516). Fixed prior note that incorrectly said "before MTP 2.0".
  • Added --filter-uid (MTP 1.8.0; PR #6002).
  • Added --treenode-filter and --no-banner (long-standing, no version annotation).
  • Documented that --list-tests accepts text/json; noted that json requires MTP 2.3.0 (PR #8280).

microsoft-testing-platform-config.md

  • Renamed env vars to current names with back-compat notes — both available in MTP 2.3.0 (PR #8388):
    • TESTINGPLATFORM_DIAGNOSTIC_OUTPUT_FILEPREFIXTESTINGPLATFORM_DIAGNOSTIC_FILE_PREFIX
    • TESTINGPLATFORM_DIAGNOSTIC_FILELOGGER_SYNCHRONOUSWRITETESTINGPLATFORM_DIAGNOSTIC_SYNCHRONOUS_WRITE
  • Added TESTINGPLATFORM_NOBANNER, DOTNET_NOLOGO.
  • Added TESTINGPLATFORM_WAIT_ATTACH_DEBUGGER and TESTINGPLATFORM_LAUNCH_ATTACH_DEBUGGER (MTP 1.6.0; PR #4829).

microsoft-testing-platform-troubleshooting.md

  • Updated the diagnostic env vars table with the new names + back-compat / version notes.

microsoft-testing-platform-crash-hang-dumps.md

  • Crash dump: added --crash-report (PR #8191), --crash-report-if-supported (PR #8666), --crash-sequence (PR #8526) — all MTP 2.3.0.
  • Hang dump: added --hangdump-type-if-supported (MTP 2.3.0; PR #8666); expanded --hangdump-type to note .NET (Core) vs .NET Framework valid values, including None (MTP 2.1.0; PR #7213); expanded --hangdump-timeout formats and --hangdump-filename placeholders.

microsoft-testing-platform-terminal-output.md

  • Added --ansi (MTP 2.3.0; PR #8493).
  • Added --show-stdout and --show-stderr (MTP 2.2.1; PR #7637).

microsoft-testing-platform-test-reports.md

  • Added every newly stabilized Azure DevOps option — all MTP 2.3.0:
    --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

  • Added --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.
  • Hidden/internal options (--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-assisted in their frontmatter.


Internal previews

📄 File🔗 Preview link
docs/core/testing/microsoft-testing-platform-cli-options.mdMicrosoft.Testing.Platform (MTP) CLI options reference
docs/core/testing/microsoft-testing-platform-config.mdMicrosoft.Testing.Platform (MTP) config options
docs/core/testing/microsoft-testing-platform-crash-hang-dumps.mdCrash and hang dumps
docs/core/testing/microsoft-testing-platform-retry.mddocs/core/testing/microsoft-testing-platform-retry
docs/core/testing/microsoft-testing-platform-terminal-output.mdTerminal output
docs/core/testing/microsoft-testing-platform-test-reports.mdMicrosoft.Testing.Platform (MTP) test reports
docs/core/testing/microsoft-testing-platform-troubleshooting.mdMicrosoft.Testing.Platform (MTP) troubleshooting

Evangelinkand others added 2 commits June 1, 2026 16:38
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>
CopilotAI review requested due to automatic review settings June 1, 2026 14:46
@dotnetrepomandotnetrepomanBot added this to the June 2026 milestone Jun 1, 2026

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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
FileDescription
docs/core/testing/microsoft-testing-platform-troubleshooting.mdUpdates diagnostic environment variable names and adds back-compat/version notes.
docs/core/testing/microsoft-testing-platform-test-reports.mdExpands Azure DevOps reporting options and adds a version availability note.
docs/core/testing/microsoft-testing-platform-terminal-output.mdDocuments additional output-related switches (--ansi, --show-stdout, --show-stderr) with version notes.
docs/core/testing/microsoft-testing-platform-retry.mdDocuments --retry-failed-tests-delay and clarifies option prerequisites.
docs/core/testing/microsoft-testing-platform-crash-hang-dumps.mdAdds crash-reporting-related options and expands hang dump option details.
docs/core/testing/microsoft-testing-platform-config.mdRenames 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.mdUpdates/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

Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-retry.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-config.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-config.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-retry.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
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>
@Evangelink
Evangelink enabled auto-merge (squash) June 2, 2026 08:10
- 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>
@Evangelink
Evangelink merged commit 47b72b7 into dotnet:mainJun 2, 2026
9 checks passed
@Evangelink
Evangelink deleted the dev/amauryleve/mtp-cli-env-vars-audit branch June 2, 2026 09:57
Sign up for freeto 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

@Evangelink@gewarren
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Audit MTP CLI options and environment variables; annotate with introduction versions - #54106

Merged
Evangelink merged 4 commits into
dotnet:mainfrom
Evangelink:dev/amauryleve/mtp-cli-env-vars-audit
Jun 2, 2026
Merged

Audit MTP CLI options and environment variables; annotate with introduction versions#54106
Evangelink merged 4 commits into
dotnet:mainfrom
Evangelink:dev/amauryleve/mtp-cli-env-vars-audit

Conversation

@Evangelink

@EvangelinkEvangelink commented Jun 1, 2026

Copy link
Copy Markdown
Member

Summary

Audits every Microsoft.Testing.Platform (MTP) CommandLineOptionsProvider and EnvironmentVariableConstants entry in microsoft/testfx and reconciles the docs in docs/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

  • Replaced removed --debug-wait-attach with --debug (MTP 1.9.0; PRs #6499, #6516). Fixed prior note that incorrectly said "before MTP 2.0".
  • Added --filter-uid (MTP 1.8.0; PR #6002).
  • Added --treenode-filter and --no-banner (long-standing, no version annotation).
  • Documented that --list-tests accepts text/json; noted that json requires MTP 2.3.0 (PR #8280).

microsoft-testing-platform-config.md

  • Renamed env vars to current names with back-compat notes — both available in MTP 2.3.0 (PR #8388):
    • TESTINGPLATFORM_DIAGNOSTIC_OUTPUT_FILEPREFIXTESTINGPLATFORM_DIAGNOSTIC_FILE_PREFIX
    • TESTINGPLATFORM_DIAGNOSTIC_FILELOGGER_SYNCHRONOUSWRITETESTINGPLATFORM_DIAGNOSTIC_SYNCHRONOUS_WRITE
  • Added TESTINGPLATFORM_NOBANNER, DOTNET_NOLOGO.
  • Added TESTINGPLATFORM_WAIT_ATTACH_DEBUGGER and TESTINGPLATFORM_LAUNCH_ATTACH_DEBUGGER (MTP 1.6.0; PR #4829).

microsoft-testing-platform-troubleshooting.md

  • Updated the diagnostic env vars table with the new names + back-compat / version notes.

microsoft-testing-platform-crash-hang-dumps.md

  • Crash dump: added --crash-report (PR #8191), --crash-report-if-supported (PR #8666), --crash-sequence (PR #8526) — all MTP 2.3.0.
  • Hang dump: added --hangdump-type-if-supported (MTP 2.3.0; PR #8666); expanded --hangdump-type to note .NET (Core) vs .NET Framework valid values, including None (MTP 2.1.0; PR #7213); expanded --hangdump-timeout formats and --hangdump-filename placeholders.

microsoft-testing-platform-terminal-output.md

  • Added --ansi (MTP 2.3.0; PR #8493).
  • Added --show-stdout and --show-stderr (MTP 2.2.1; PR #7637).

microsoft-testing-platform-test-reports.md

  • Added every newly stabilized Azure DevOps option — all MTP 2.3.0:
    --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

  • Added --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.
  • Hidden/internal options (--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-assisted in their frontmatter.


Internal previews

📄 File🔗 Preview link
docs/core/testing/microsoft-testing-platform-cli-options.mdMicrosoft.Testing.Platform (MTP) CLI options reference
docs/core/testing/microsoft-testing-platform-config.mdMicrosoft.Testing.Platform (MTP) config options
docs/core/testing/microsoft-testing-platform-crash-hang-dumps.mdCrash and hang dumps
docs/core/testing/microsoft-testing-platform-retry.mddocs/core/testing/microsoft-testing-platform-retry
docs/core/testing/microsoft-testing-platform-terminal-output.mdTerminal output
docs/core/testing/microsoft-testing-platform-test-reports.mdMicrosoft.Testing.Platform (MTP) test reports
docs/core/testing/microsoft-testing-platform-troubleshooting.mdMicrosoft.Testing.Platform (MTP) troubleshooting

Evangelinkand others added 2 commits June 1, 2026 16:38
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>
CopilotAI review requested due to automatic review settings June 1, 2026 14:46
@dotnetrepomandotnetrepomanBot added this to the June 2026 milestone Jun 1, 2026

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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
FileDescription
docs/core/testing/microsoft-testing-platform-troubleshooting.mdUpdates diagnostic environment variable names and adds back-compat/version notes.
docs/core/testing/microsoft-testing-platform-test-reports.mdExpands Azure DevOps reporting options and adds a version availability note.
docs/core/testing/microsoft-testing-platform-terminal-output.mdDocuments additional output-related switches (--ansi, --show-stdout, --show-stderr) with version notes.
docs/core/testing/microsoft-testing-platform-retry.mdDocuments --retry-failed-tests-delay and clarifies option prerequisites.
docs/core/testing/microsoft-testing-platform-crash-hang-dumps.mdAdds crash-reporting-related options and expands hang dump option details.
docs/core/testing/microsoft-testing-platform-config.mdRenames 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.mdUpdates/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

Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-retry.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-config.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-config.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-retry.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
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>
@Evangelink
Evangelink enabled auto-merge (squash) June 2, 2026 08:10
- 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>
@Evangelink
Evangelink merged commit 47b72b7 into dotnet:mainJun 2, 2026
9 checks passed
@Evangelink
Evangelink deleted the dev/amauryleve/mtp-cli-env-vars-audit branch June 2, 2026 09:57
Sign up for freeto 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

@Evangelink@gewarren
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Audit MTP CLI options and environment variables; annotate with introduction versions - #54106

Merged
Evangelink merged 4 commits into
dotnet:mainfrom
Evangelink:dev/amauryleve/mtp-cli-env-vars-audit
Jun 2, 2026
Merged

Audit MTP CLI options and environment variables; annotate with introduction versions#54106
Evangelink merged 4 commits into
dotnet:mainfrom
Evangelink:dev/amauryleve/mtp-cli-env-vars-audit

Conversation

@Evangelink

@EvangelinkEvangelink commented Jun 1, 2026

Copy link
Copy Markdown
Member

Summary

Audits every Microsoft.Testing.Platform (MTP) CommandLineOptionsProvider and EnvironmentVariableConstants entry in microsoft/testfx and reconciles the docs in docs/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

  • Replaced removed --debug-wait-attach with --debug (MTP 1.9.0; PRs #6499, #6516). Fixed prior note that incorrectly said "before MTP 2.0".
  • Added --filter-uid (MTP 1.8.0; PR #6002).
  • Added --treenode-filter and --no-banner (long-standing, no version annotation).
  • Documented that --list-tests accepts text/json; noted that json requires MTP 2.3.0 (PR #8280).

microsoft-testing-platform-config.md

  • Renamed env vars to current names with back-compat notes — both available in MTP 2.3.0 (PR #8388):
    • TESTINGPLATFORM_DIAGNOSTIC_OUTPUT_FILEPREFIXTESTINGPLATFORM_DIAGNOSTIC_FILE_PREFIX
    • TESTINGPLATFORM_DIAGNOSTIC_FILELOGGER_SYNCHRONOUSWRITETESTINGPLATFORM_DIAGNOSTIC_SYNCHRONOUS_WRITE
  • Added TESTINGPLATFORM_NOBANNER, DOTNET_NOLOGO.
  • Added TESTINGPLATFORM_WAIT_ATTACH_DEBUGGER and TESTINGPLATFORM_LAUNCH_ATTACH_DEBUGGER (MTP 1.6.0; PR #4829).

microsoft-testing-platform-troubleshooting.md

  • Updated the diagnostic env vars table with the new names + back-compat / version notes.

microsoft-testing-platform-crash-hang-dumps.md

  • Crash dump: added --crash-report (PR #8191), --crash-report-if-supported (PR #8666), --crash-sequence (PR #8526) — all MTP 2.3.0.
  • Hang dump: added --hangdump-type-if-supported (MTP 2.3.0; PR #8666); expanded --hangdump-type to note .NET (Core) vs .NET Framework valid values, including None (MTP 2.1.0; PR #7213); expanded --hangdump-timeout formats and --hangdump-filename placeholders.

microsoft-testing-platform-terminal-output.md

  • Added --ansi (MTP 2.3.0; PR #8493).
  • Added --show-stdout and --show-stderr (MTP 2.2.1; PR #7637).

microsoft-testing-platform-test-reports.md

  • Added every newly stabilized Azure DevOps option — all MTP 2.3.0:
    --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

  • Added --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.
  • Hidden/internal options (--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-assisted in their frontmatter.


Internal previews

📄 File🔗 Preview link
docs/core/testing/microsoft-testing-platform-cli-options.mdMicrosoft.Testing.Platform (MTP) CLI options reference
docs/core/testing/microsoft-testing-platform-config.mdMicrosoft.Testing.Platform (MTP) config options
docs/core/testing/microsoft-testing-platform-crash-hang-dumps.mdCrash and hang dumps
docs/core/testing/microsoft-testing-platform-retry.mddocs/core/testing/microsoft-testing-platform-retry
docs/core/testing/microsoft-testing-platform-terminal-output.mdTerminal output
docs/core/testing/microsoft-testing-platform-test-reports.mdMicrosoft.Testing.Platform (MTP) test reports
docs/core/testing/microsoft-testing-platform-troubleshooting.mdMicrosoft.Testing.Platform (MTP) troubleshooting

Evangelinkand others added 2 commits June 1, 2026 16:38
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>
CopilotAI review requested due to automatic review settings June 1, 2026 14:46
@dotnetrepomandotnetrepomanBot added this to the June 2026 milestone Jun 1, 2026

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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
FileDescription
docs/core/testing/microsoft-testing-platform-troubleshooting.mdUpdates diagnostic environment variable names and adds back-compat/version notes.
docs/core/testing/microsoft-testing-platform-test-reports.mdExpands Azure DevOps reporting options and adds a version availability note.
docs/core/testing/microsoft-testing-platform-terminal-output.mdDocuments additional output-related switches (--ansi, --show-stdout, --show-stderr) with version notes.
docs/core/testing/microsoft-testing-platform-retry.mdDocuments --retry-failed-tests-delay and clarifies option prerequisites.
docs/core/testing/microsoft-testing-platform-crash-hang-dumps.mdAdds crash-reporting-related options and expands hang dump option details.
docs/core/testing/microsoft-testing-platform-config.mdRenames 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.mdUpdates/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

Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-retry.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-config.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-config.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-retry.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
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>
@Evangelink
Evangelink enabled auto-merge (squash) June 2, 2026 08:10
- 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>
@Evangelink
Evangelink merged commit 47b72b7 into dotnet:mainJun 2, 2026
9 checks passed
@Evangelink
Evangelink deleted the dev/amauryleve/mtp-cli-env-vars-audit branch June 2, 2026 09:57
Sign up for freeto 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

@Evangelink@gewarren
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Audit MTP CLI options and environment variables; annotate with introduction versions - #54106

Merged
Evangelink merged 4 commits into
dotnet:mainfrom
Evangelink:dev/amauryleve/mtp-cli-env-vars-audit
Jun 2, 2026
Merged

Audit MTP CLI options and environment variables; annotate with introduction versions#54106
Evangelink merged 4 commits into
dotnet:mainfrom
Evangelink:dev/amauryleve/mtp-cli-env-vars-audit

Conversation

@Evangelink

@EvangelinkEvangelink commented Jun 1, 2026

Copy link
Copy Markdown
Member

Summary

Audits every Microsoft.Testing.Platform (MTP) CommandLineOptionsProvider and EnvironmentVariableConstants entry in microsoft/testfx and reconciles the docs in docs/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

  • Replaced removed --debug-wait-attach with --debug (MTP 1.9.0; PRs #6499, #6516). Fixed prior note that incorrectly said "before MTP 2.0".
  • Added --filter-uid (MTP 1.8.0; PR #6002).
  • Added --treenode-filter and --no-banner (long-standing, no version annotation).
  • Documented that --list-tests accepts text/json; noted that json requires MTP 2.3.0 (PR #8280).

microsoft-testing-platform-config.md

  • Renamed env vars to current names with back-compat notes — both available in MTP 2.3.0 (PR #8388):
    • TESTINGPLATFORM_DIAGNOSTIC_OUTPUT_FILEPREFIXTESTINGPLATFORM_DIAGNOSTIC_FILE_PREFIX
    • TESTINGPLATFORM_DIAGNOSTIC_FILELOGGER_SYNCHRONOUSWRITETESTINGPLATFORM_DIAGNOSTIC_SYNCHRONOUS_WRITE
  • Added TESTINGPLATFORM_NOBANNER, DOTNET_NOLOGO.
  • Added TESTINGPLATFORM_WAIT_ATTACH_DEBUGGER and TESTINGPLATFORM_LAUNCH_ATTACH_DEBUGGER (MTP 1.6.0; PR #4829).

microsoft-testing-platform-troubleshooting.md

  • Updated the diagnostic env vars table with the new names + back-compat / version notes.

microsoft-testing-platform-crash-hang-dumps.md

  • Crash dump: added --crash-report (PR #8191), --crash-report-if-supported (PR #8666), --crash-sequence (PR #8526) — all MTP 2.3.0.
  • Hang dump: added --hangdump-type-if-supported (MTP 2.3.0; PR #8666); expanded --hangdump-type to note .NET (Core) vs .NET Framework valid values, including None (MTP 2.1.0; PR #7213); expanded --hangdump-timeout formats and --hangdump-filename placeholders.

microsoft-testing-platform-terminal-output.md

  • Added --ansi (MTP 2.3.0; PR #8493).
  • Added --show-stdout and --show-stderr (MTP 2.2.1; PR #7637).

microsoft-testing-platform-test-reports.md

  • Added every newly stabilized Azure DevOps option — all MTP 2.3.0:
    --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

  • Added --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.
  • Hidden/internal options (--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-assisted in their frontmatter.


Internal previews

📄 File🔗 Preview link
docs/core/testing/microsoft-testing-platform-cli-options.mdMicrosoft.Testing.Platform (MTP) CLI options reference
docs/core/testing/microsoft-testing-platform-config.mdMicrosoft.Testing.Platform (MTP) config options
docs/core/testing/microsoft-testing-platform-crash-hang-dumps.mdCrash and hang dumps
docs/core/testing/microsoft-testing-platform-retry.mddocs/core/testing/microsoft-testing-platform-retry
docs/core/testing/microsoft-testing-platform-terminal-output.mdTerminal output
docs/core/testing/microsoft-testing-platform-test-reports.mdMicrosoft.Testing.Platform (MTP) test reports
docs/core/testing/microsoft-testing-platform-troubleshooting.mdMicrosoft.Testing.Platform (MTP) troubleshooting

Evangelinkand others added 2 commits June 1, 2026 16:38
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>
CopilotAI review requested due to automatic review settings June 1, 2026 14:46
@dotnetrepomandotnetrepomanBot added this to the June 2026 milestone Jun 1, 2026

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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
FileDescription
docs/core/testing/microsoft-testing-platform-troubleshooting.mdUpdates diagnostic environment variable names and adds back-compat/version notes.
docs/core/testing/microsoft-testing-platform-test-reports.mdExpands Azure DevOps reporting options and adds a version availability note.
docs/core/testing/microsoft-testing-platform-terminal-output.mdDocuments additional output-related switches (--ansi, --show-stdout, --show-stderr) with version notes.
docs/core/testing/microsoft-testing-platform-retry.mdDocuments --retry-failed-tests-delay and clarifies option prerequisites.
docs/core/testing/microsoft-testing-platform-crash-hang-dumps.mdAdds crash-reporting-related options and expands hang dump option details.
docs/core/testing/microsoft-testing-platform-config.mdRenames 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.mdUpdates/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

Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-retry.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-config.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-config.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-retry.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
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>
@Evangelink
Evangelink enabled auto-merge (squash) June 2, 2026 08:10
- 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>
@Evangelink
Evangelink merged commit 47b72b7 into dotnet:mainJun 2, 2026
9 checks passed
@Evangelink
Evangelink deleted the dev/amauryleve/mtp-cli-env-vars-audit branch June 2, 2026 09:57
Sign up for freeto 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

@Evangelink@gewarren
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Audit MTP CLI options and environment variables; annotate with introduction versions - #54106

Merged
Evangelink merged 4 commits into
dotnet:mainfrom
Evangelink:dev/amauryleve/mtp-cli-env-vars-audit
Jun 2, 2026
Merged

Audit MTP CLI options and environment variables; annotate with introduction versions#54106
Evangelink merged 4 commits into
dotnet:mainfrom
Evangelink:dev/amauryleve/mtp-cli-env-vars-audit

Conversation

@Evangelink

@EvangelinkEvangelink commented Jun 1, 2026

Copy link
Copy Markdown
Member

Summary

Audits every Microsoft.Testing.Platform (MTP) CommandLineOptionsProvider and EnvironmentVariableConstants entry in microsoft/testfx and reconciles the docs in docs/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

  • Replaced removed --debug-wait-attach with --debug (MTP 1.9.0; PRs #6499, #6516). Fixed prior note that incorrectly said "before MTP 2.0".
  • Added --filter-uid (MTP 1.8.0; PR #6002).
  • Added --treenode-filter and --no-banner (long-standing, no version annotation).
  • Documented that --list-tests accepts text/json; noted that json requires MTP 2.3.0 (PR #8280).

microsoft-testing-platform-config.md

  • Renamed env vars to current names with back-compat notes — both available in MTP 2.3.0 (PR #8388):
    • TESTINGPLATFORM_DIAGNOSTIC_OUTPUT_FILEPREFIXTESTINGPLATFORM_DIAGNOSTIC_FILE_PREFIX
    • TESTINGPLATFORM_DIAGNOSTIC_FILELOGGER_SYNCHRONOUSWRITETESTINGPLATFORM_DIAGNOSTIC_SYNCHRONOUS_WRITE
  • Added TESTINGPLATFORM_NOBANNER, DOTNET_NOLOGO.
  • Added TESTINGPLATFORM_WAIT_ATTACH_DEBUGGER and TESTINGPLATFORM_LAUNCH_ATTACH_DEBUGGER (MTP 1.6.0; PR #4829).

microsoft-testing-platform-troubleshooting.md

  • Updated the diagnostic env vars table with the new names + back-compat / version notes.

microsoft-testing-platform-crash-hang-dumps.md

  • Crash dump: added --crash-report (PR #8191), --crash-report-if-supported (PR #8666), --crash-sequence (PR #8526) — all MTP 2.3.0.
  • Hang dump: added --hangdump-type-if-supported (MTP 2.3.0; PR #8666); expanded --hangdump-type to note .NET (Core) vs .NET Framework valid values, including None (MTP 2.1.0; PR #7213); expanded --hangdump-timeout formats and --hangdump-filename placeholders.

microsoft-testing-platform-terminal-output.md

  • Added --ansi (MTP 2.3.0; PR #8493).
  • Added --show-stdout and --show-stderr (MTP 2.2.1; PR #7637).

microsoft-testing-platform-test-reports.md

  • Added every newly stabilized Azure DevOps option — all MTP 2.3.0:
    --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

  • Added --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.
  • Hidden/internal options (--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-assisted in their frontmatter.


Internal previews

📄 File🔗 Preview link
docs/core/testing/microsoft-testing-platform-cli-options.mdMicrosoft.Testing.Platform (MTP) CLI options reference
docs/core/testing/microsoft-testing-platform-config.mdMicrosoft.Testing.Platform (MTP) config options
docs/core/testing/microsoft-testing-platform-crash-hang-dumps.mdCrash and hang dumps
docs/core/testing/microsoft-testing-platform-retry.mddocs/core/testing/microsoft-testing-platform-retry
docs/core/testing/microsoft-testing-platform-terminal-output.mdTerminal output
docs/core/testing/microsoft-testing-platform-test-reports.mdMicrosoft.Testing.Platform (MTP) test reports
docs/core/testing/microsoft-testing-platform-troubleshooting.mdMicrosoft.Testing.Platform (MTP) troubleshooting

Evangelinkand others added 2 commits June 1, 2026 16:38
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>
CopilotAI review requested due to automatic review settings June 1, 2026 14:46
@dotnetrepomandotnetrepomanBot added this to the June 2026 milestone Jun 1, 2026

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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
FileDescription
docs/core/testing/microsoft-testing-platform-troubleshooting.mdUpdates diagnostic environment variable names and adds back-compat/version notes.
docs/core/testing/microsoft-testing-platform-test-reports.mdExpands Azure DevOps reporting options and adds a version availability note.
docs/core/testing/microsoft-testing-platform-terminal-output.mdDocuments additional output-related switches (--ansi, --show-stdout, --show-stderr) with version notes.
docs/core/testing/microsoft-testing-platform-retry.mdDocuments --retry-failed-tests-delay and clarifies option prerequisites.
docs/core/testing/microsoft-testing-platform-crash-hang-dumps.mdAdds crash-reporting-related options and expands hang dump option details.
docs/core/testing/microsoft-testing-platform-config.mdRenames 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.mdUpdates/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

Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-retry.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-config.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-config.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-retry.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
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>
@Evangelink
Evangelink enabled auto-merge (squash) June 2, 2026 08:10
- 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>
@Evangelink
Evangelink merged commit 47b72b7 into dotnet:mainJun 2, 2026
9 checks passed
@Evangelink
Evangelink deleted the dev/amauryleve/mtp-cli-env-vars-audit branch June 2, 2026 09:57
Sign up for freeto 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

@Evangelink@gewarren
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Audit MTP CLI options and environment variables; annotate with introduction versions - #54106

Merged
Evangelink merged 4 commits into
dotnet:mainfrom
Evangelink:dev/amauryleve/mtp-cli-env-vars-audit
Jun 2, 2026
Merged

Audit MTP CLI options and environment variables; annotate with introduction versions#54106
Evangelink merged 4 commits into
dotnet:mainfrom
Evangelink:dev/amauryleve/mtp-cli-env-vars-audit

Conversation

@Evangelink

@EvangelinkEvangelink commented Jun 1, 2026

Copy link
Copy Markdown
Member

Summary

Audits every Microsoft.Testing.Platform (MTP) CommandLineOptionsProvider and EnvironmentVariableConstants entry in microsoft/testfx and reconciles the docs in docs/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

  • Replaced removed --debug-wait-attach with --debug (MTP 1.9.0; PRs #6499, #6516). Fixed prior note that incorrectly said "before MTP 2.0".
  • Added --filter-uid (MTP 1.8.0; PR #6002).
  • Added --treenode-filter and --no-banner (long-standing, no version annotation).
  • Documented that --list-tests accepts text/json; noted that json requires MTP 2.3.0 (PR #8280).

microsoft-testing-platform-config.md

  • Renamed env vars to current names with back-compat notes — both available in MTP 2.3.0 (PR #8388):
    • TESTINGPLATFORM_DIAGNOSTIC_OUTPUT_FILEPREFIXTESTINGPLATFORM_DIAGNOSTIC_FILE_PREFIX
    • TESTINGPLATFORM_DIAGNOSTIC_FILELOGGER_SYNCHRONOUSWRITETESTINGPLATFORM_DIAGNOSTIC_SYNCHRONOUS_WRITE
  • Added TESTINGPLATFORM_NOBANNER, DOTNET_NOLOGO.
  • Added TESTINGPLATFORM_WAIT_ATTACH_DEBUGGER and TESTINGPLATFORM_LAUNCH_ATTACH_DEBUGGER (MTP 1.6.0; PR #4829).

microsoft-testing-platform-troubleshooting.md

  • Updated the diagnostic env vars table with the new names + back-compat / version notes.

microsoft-testing-platform-crash-hang-dumps.md

  • Crash dump: added --crash-report (PR #8191), --crash-report-if-supported (PR #8666), --crash-sequence (PR #8526) — all MTP 2.3.0.
  • Hang dump: added --hangdump-type-if-supported (MTP 2.3.0; PR #8666); expanded --hangdump-type to note .NET (Core) vs .NET Framework valid values, including None (MTP 2.1.0; PR #7213); expanded --hangdump-timeout formats and --hangdump-filename placeholders.

microsoft-testing-platform-terminal-output.md

  • Added --ansi (MTP 2.3.0; PR #8493).
  • Added --show-stdout and --show-stderr (MTP 2.2.1; PR #7637).

microsoft-testing-platform-test-reports.md

  • Added every newly stabilized Azure DevOps option — all MTP 2.3.0:
    --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

  • Added --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.
  • Hidden/internal options (--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-assisted in their frontmatter.


Internal previews

📄 File🔗 Preview link
docs/core/testing/microsoft-testing-platform-cli-options.mdMicrosoft.Testing.Platform (MTP) CLI options reference
docs/core/testing/microsoft-testing-platform-config.mdMicrosoft.Testing.Platform (MTP) config options
docs/core/testing/microsoft-testing-platform-crash-hang-dumps.mdCrash and hang dumps
docs/core/testing/microsoft-testing-platform-retry.mddocs/core/testing/microsoft-testing-platform-retry
docs/core/testing/microsoft-testing-platform-terminal-output.mdTerminal output
docs/core/testing/microsoft-testing-platform-test-reports.mdMicrosoft.Testing.Platform (MTP) test reports
docs/core/testing/microsoft-testing-platform-troubleshooting.mdMicrosoft.Testing.Platform (MTP) troubleshooting

Evangelinkand others added 2 commits June 1, 2026 16:38
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>
CopilotAI review requested due to automatic review settings June 1, 2026 14:46
@dotnetrepomandotnetrepomanBot added this to the June 2026 milestone Jun 1, 2026

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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
FileDescription
docs/core/testing/microsoft-testing-platform-troubleshooting.mdUpdates diagnostic environment variable names and adds back-compat/version notes.
docs/core/testing/microsoft-testing-platform-test-reports.mdExpands Azure DevOps reporting options and adds a version availability note.
docs/core/testing/microsoft-testing-platform-terminal-output.mdDocuments additional output-related switches (--ansi, --show-stdout, --show-stderr) with version notes.
docs/core/testing/microsoft-testing-platform-retry.mdDocuments --retry-failed-tests-delay and clarifies option prerequisites.
docs/core/testing/microsoft-testing-platform-crash-hang-dumps.mdAdds crash-reporting-related options and expands hang dump option details.
docs/core/testing/microsoft-testing-platform-config.mdRenames 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.mdUpdates/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

Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-retry.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-config.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-config.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-retry.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
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>
@Evangelink
Evangelink enabled auto-merge (squash) June 2, 2026 08:10
- 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>
@Evangelink
Evangelink merged commit 47b72b7 into dotnet:mainJun 2, 2026
9 checks passed
@Evangelink
Evangelink deleted the dev/amauryleve/mtp-cli-env-vars-audit branch June 2, 2026 09:57
Sign up for freeto 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

@Evangelink@gewarren
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Audit MTP CLI options and environment variables; annotate with introduction versions - #54106

Merged
Evangelink merged 4 commits into
dotnet:mainfrom
Evangelink:dev/amauryleve/mtp-cli-env-vars-audit
Jun 2, 2026
Merged

Audit MTP CLI options and environment variables; annotate with introduction versions#54106
Evangelink merged 4 commits into
dotnet:mainfrom
Evangelink:dev/amauryleve/mtp-cli-env-vars-audit

Conversation

@Evangelink

@EvangelinkEvangelink commented Jun 1, 2026

Copy link
Copy Markdown
Member

Summary

Audits every Microsoft.Testing.Platform (MTP) CommandLineOptionsProvider and EnvironmentVariableConstants entry in microsoft/testfx and reconciles the docs in docs/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

  • Replaced removed --debug-wait-attach with --debug (MTP 1.9.0; PRs #6499, #6516). Fixed prior note that incorrectly said "before MTP 2.0".
  • Added --filter-uid (MTP 1.8.0; PR #6002).
  • Added --treenode-filter and --no-banner (long-standing, no version annotation).
  • Documented that --list-tests accepts text/json; noted that json requires MTP 2.3.0 (PR #8280).

microsoft-testing-platform-config.md

  • Renamed env vars to current names with back-compat notes — both available in MTP 2.3.0 (PR #8388):
    • TESTINGPLATFORM_DIAGNOSTIC_OUTPUT_FILEPREFIXTESTINGPLATFORM_DIAGNOSTIC_FILE_PREFIX
    • TESTINGPLATFORM_DIAGNOSTIC_FILELOGGER_SYNCHRONOUSWRITETESTINGPLATFORM_DIAGNOSTIC_SYNCHRONOUS_WRITE
  • Added TESTINGPLATFORM_NOBANNER, DOTNET_NOLOGO.
  • Added TESTINGPLATFORM_WAIT_ATTACH_DEBUGGER and TESTINGPLATFORM_LAUNCH_ATTACH_DEBUGGER (MTP 1.6.0; PR #4829).

microsoft-testing-platform-troubleshooting.md

  • Updated the diagnostic env vars table with the new names + back-compat / version notes.

microsoft-testing-platform-crash-hang-dumps.md

  • Crash dump: added --crash-report (PR #8191), --crash-report-if-supported (PR #8666), --crash-sequence (PR #8526) — all MTP 2.3.0.
  • Hang dump: added --hangdump-type-if-supported (MTP 2.3.0; PR #8666); expanded --hangdump-type to note .NET (Core) vs .NET Framework valid values, including None (MTP 2.1.0; PR #7213); expanded --hangdump-timeout formats and --hangdump-filename placeholders.

microsoft-testing-platform-terminal-output.md

  • Added --ansi (MTP 2.3.0; PR #8493).
  • Added --show-stdout and --show-stderr (MTP 2.2.1; PR #7637).

microsoft-testing-platform-test-reports.md

  • Added every newly stabilized Azure DevOps option — all MTP 2.3.0:
    --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

  • Added --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.
  • Hidden/internal options (--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-assisted in their frontmatter.


Internal previews

📄 File🔗 Preview link
docs/core/testing/microsoft-testing-platform-cli-options.mdMicrosoft.Testing.Platform (MTP) CLI options reference
docs/core/testing/microsoft-testing-platform-config.mdMicrosoft.Testing.Platform (MTP) config options
docs/core/testing/microsoft-testing-platform-crash-hang-dumps.mdCrash and hang dumps
docs/core/testing/microsoft-testing-platform-retry.mddocs/core/testing/microsoft-testing-platform-retry
docs/core/testing/microsoft-testing-platform-terminal-output.mdTerminal output
docs/core/testing/microsoft-testing-platform-test-reports.mdMicrosoft.Testing.Platform (MTP) test reports
docs/core/testing/microsoft-testing-platform-troubleshooting.mdMicrosoft.Testing.Platform (MTP) troubleshooting

Evangelinkand others added 2 commits June 1, 2026 16:38
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>
CopilotAI review requested due to automatic review settings June 1, 2026 14:46
@dotnetrepomandotnetrepomanBot added this to the June 2026 milestone Jun 1, 2026

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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
FileDescription
docs/core/testing/microsoft-testing-platform-troubleshooting.mdUpdates diagnostic environment variable names and adds back-compat/version notes.
docs/core/testing/microsoft-testing-platform-test-reports.mdExpands Azure DevOps reporting options and adds a version availability note.
docs/core/testing/microsoft-testing-platform-terminal-output.mdDocuments additional output-related switches (--ansi, --show-stdout, --show-stderr) with version notes.
docs/core/testing/microsoft-testing-platform-retry.mdDocuments --retry-failed-tests-delay and clarifies option prerequisites.
docs/core/testing/microsoft-testing-platform-crash-hang-dumps.mdAdds crash-reporting-related options and expands hang dump option details.
docs/core/testing/microsoft-testing-platform-config.mdRenames 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.mdUpdates/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

Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-retry.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-config.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-config.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-retry.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
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>
@Evangelink
Evangelink enabled auto-merge (squash) June 2, 2026 08:10
- 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>
@Evangelink
Evangelink merged commit 47b72b7 into dotnet:mainJun 2, 2026
9 checks passed
@Evangelink
Evangelink deleted the dev/amauryleve/mtp-cli-env-vars-audit branch June 2, 2026 09:57
Sign up for freeto 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

@Evangelink@gewarren
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Audit MTP CLI options and environment variables; annotate with introduction versions - #54106

Merged
Evangelink merged 4 commits into
dotnet:mainfrom
Evangelink:dev/amauryleve/mtp-cli-env-vars-audit
Jun 2, 2026
Merged

Audit MTP CLI options and environment variables; annotate with introduction versions#54106
Evangelink merged 4 commits into
dotnet:mainfrom
Evangelink:dev/amauryleve/mtp-cli-env-vars-audit

Conversation

@Evangelink

@EvangelinkEvangelink commented Jun 1, 2026

Copy link
Copy Markdown
Member

Summary

Audits every Microsoft.Testing.Platform (MTP) CommandLineOptionsProvider and EnvironmentVariableConstants entry in microsoft/testfx and reconciles the docs in docs/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

  • Replaced removed --debug-wait-attach with --debug (MTP 1.9.0; PRs #6499, #6516). Fixed prior note that incorrectly said "before MTP 2.0".
  • Added --filter-uid (MTP 1.8.0; PR #6002).
  • Added --treenode-filter and --no-banner (long-standing, no version annotation).
  • Documented that --list-tests accepts text/json; noted that json requires MTP 2.3.0 (PR #8280).

microsoft-testing-platform-config.md

  • Renamed env vars to current names with back-compat notes — both available in MTP 2.3.0 (PR #8388):
    • TESTINGPLATFORM_DIAGNOSTIC_OUTPUT_FILEPREFIXTESTINGPLATFORM_DIAGNOSTIC_FILE_PREFIX
    • TESTINGPLATFORM_DIAGNOSTIC_FILELOGGER_SYNCHRONOUSWRITETESTINGPLATFORM_DIAGNOSTIC_SYNCHRONOUS_WRITE
  • Added TESTINGPLATFORM_NOBANNER, DOTNET_NOLOGO.
  • Added TESTINGPLATFORM_WAIT_ATTACH_DEBUGGER and TESTINGPLATFORM_LAUNCH_ATTACH_DEBUGGER (MTP 1.6.0; PR #4829).

microsoft-testing-platform-troubleshooting.md

  • Updated the diagnostic env vars table with the new names + back-compat / version notes.

microsoft-testing-platform-crash-hang-dumps.md

  • Crash dump: added --crash-report (PR #8191), --crash-report-if-supported (PR #8666), --crash-sequence (PR #8526) — all MTP 2.3.0.
  • Hang dump: added --hangdump-type-if-supported (MTP 2.3.0; PR #8666); expanded --hangdump-type to note .NET (Core) vs .NET Framework valid values, including None (MTP 2.1.0; PR #7213); expanded --hangdump-timeout formats and --hangdump-filename placeholders.

microsoft-testing-platform-terminal-output.md

  • Added --ansi (MTP 2.3.0; PR #8493).
  • Added --show-stdout and --show-stderr (MTP 2.2.1; PR #7637).

microsoft-testing-platform-test-reports.md

  • Added every newly stabilized Azure DevOps option — all MTP 2.3.0:
    --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

  • Added --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.
  • Hidden/internal options (--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-assisted in their frontmatter.


Internal previews

📄 File🔗 Preview link
docs/core/testing/microsoft-testing-platform-cli-options.mdMicrosoft.Testing.Platform (MTP) CLI options reference
docs/core/testing/microsoft-testing-platform-config.mdMicrosoft.Testing.Platform (MTP) config options
docs/core/testing/microsoft-testing-platform-crash-hang-dumps.mdCrash and hang dumps
docs/core/testing/microsoft-testing-platform-retry.mddocs/core/testing/microsoft-testing-platform-retry
docs/core/testing/microsoft-testing-platform-terminal-output.mdTerminal output
docs/core/testing/microsoft-testing-platform-test-reports.mdMicrosoft.Testing.Platform (MTP) test reports
docs/core/testing/microsoft-testing-platform-troubleshooting.mdMicrosoft.Testing.Platform (MTP) troubleshooting

Evangelinkand others added 2 commits June 1, 2026 16:38
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>
CopilotAI review requested due to automatic review settings June 1, 2026 14:46
@dotnetrepomandotnetrepomanBot added this to the June 2026 milestone Jun 1, 2026

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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
FileDescription
docs/core/testing/microsoft-testing-platform-troubleshooting.mdUpdates diagnostic environment variable names and adds back-compat/version notes.
docs/core/testing/microsoft-testing-platform-test-reports.mdExpands Azure DevOps reporting options and adds a version availability note.
docs/core/testing/microsoft-testing-platform-terminal-output.mdDocuments additional output-related switches (--ansi, --show-stdout, --show-stderr) with version notes.
docs/core/testing/microsoft-testing-platform-retry.mdDocuments --retry-failed-tests-delay and clarifies option prerequisites.
docs/core/testing/microsoft-testing-platform-crash-hang-dumps.mdAdds crash-reporting-related options and expands hang dump option details.
docs/core/testing/microsoft-testing-platform-config.mdRenames 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.mdUpdates/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

Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-retry.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-config.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-config.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-crash-hang-dumps.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-retry.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
Comment threaddocs/core/testing/microsoft-testing-platform-terminal-output.md Outdated
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>
@Evangelink
Evangelink enabled auto-merge (squash) June 2, 2026 08:10
- 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>
@Evangelink
Evangelink merged commit 47b72b7 into dotnet:mainJun 2, 2026
9 checks passed
@Evangelink
Evangelink deleted the dev/amauryleve/mtp-cli-env-vars-audit branch June 2, 2026 09:57
Sign up for freeto 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

@Evangelink@gewarren