Skip to content

Add documentation of environment variables #15095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jun 17, 2025
Merged

Add documentation of environment variables #15095

merged 3 commits into from
Jun 17, 2025

Conversation

Copy link
Contributor

Copilot AI commented Jun 12, 2025

Thanks for assigning this issue to me. I'm starting to work on it and will keep this PR's description up to date as I form a plan and make progress.

Original issue description:

There seems to be no documentation of the environment variables understood/handled by vstest.

For example, VSTEST_TESTHOST_SHUTDOWN_TIMEOUT seems to only appear in the code and a couple of time in issues in this repo (even taking into account a web search).

It would be very convenient to have some document that collects all of the variables and explains them, just like https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-environment-variables

(this is not a bug, but a feature request)

Fixes #5065.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@nohwnd
Copy link
Member

nohwnd commented Jun 12, 2025

looks like your session timed out. Try again.

@nohwnd
Copy link
Member

nohwnd commented Jun 13, 2025

@copilot try one more time.

@nohwnd
Add comprehensive environment variables documentation
45467fe 
- Document all VSTEST_* environment variables found in codebase
- Organize by category (debug, timeout, diagnostics, feature flags, etc.)
- Include descriptions, examples, and usage notes
- Add to README and table of contents
- Addresses issue #5065

Co-authored-by: nohwnd <[email protected]>
Copy link
Contributor Author

Copilot AI commented Jun 13, 2025

@copilot try one more time.

I've now created comprehensive environment variables documentation as requested in issue #5065. The documentation includes all 40+ VSTEST_* environment variables found in the codebase, organized by category with detailed descriptions, examples, and usage notes. Added in commit 45467fe.

Copilot finished work on behalf of nohwnd June 13, 2025 15:51
nohwnd
nohwnd reviewed Jun 16, 2025
View reviewed changes
Copy link
Member

@nohwnd nohwnd left a comment

Choose a reason for hiding this comment

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

@copilot, apply the suggestions please.

Copy link
Contributor Author

Copilot AI commented Jun 16, 2025

@copilot, apply the suggestions please.

Applied all the suggested changes to improve the documentation descriptions for AttachVS tool requirements and dump upload behavior. Changes made in commit aa606be.

Copilot finished work on behalf of nohwnd June 16, 2025 12:00
@nohwnd nohwnd marked this pull request as ready for review June 16, 2025 12:19
@nohwnd nohwnd changed the title [WIP] Add documentation of environment variables Add documentation of environment variables Jun 16, 2025
@nohwnd nohwnd enabled auto-merge (squash) June 17, 2025 07:27
@nohwnd nohwnd merged commit 523bf7b into main Jun 17, 2025
3 checks passed
@nohwnd nohwnd deleted the copilot/fix-5065 branch June 17, 2025 07:29
This was referenced Oct 2, 2025
Merged
Merged
Merged
Closed
Merged
Merged
Closed
This was referenced Oct 24, 2025
Closed
Open
Merged
Closed
Open
Merged
Merged
Merged
Open
Merged
Merged
Merged
Open
Merged
craigktreasure pushed a commit to craigktreasure/Treasure.Analyzers that referenced this pull request Oct 25, 2025
@dependabot
Bump Microsoft.NET.Test.Sdk from 17.14.1 to 18.0.0 (#131)
aedaf4d 
Updated [Microsoft.NET.Test.Sdk](https://github.com/microsoft/vstest)
from 17.14.1 to 18.0.0.

<details>
<summary>Release notes</summary>

_Sourced from [Microsoft.NET.Test.Sdk's
releases](https://github.com/microsoft/vstest/releases)._

## 18.0.0

## What's Changed

* Update reporting formatting by @​martincostello in
microsoft/vstest#15082
* Fix stack trace for Trace.Fail and Debug.Fail by @​nohwnd in
microsoft/vstest#15103
* Add documentation of environment variables by @​Copilot in
microsoft/vstest#15095
* IFrameworkHandle.LaunchProcessWithDebuggerAttached allows null for
workingDirectory in signature but throws by @​Copilot in
microsoft/vstest#15091
* Add Dependabot configuration for .NET SDK updates by @​JamieMagee in
microsoft/vstest#15114
* Handle dotnet_root in testhost version aware way by @​nohwnd in
microsoft/vstest#15184
* Add magic bytes validation for Mach-O binaries in DotnetHostHelper by
@​Copilot in microsoft/vstest#15230
* using globbing pattern doesn't work on windows with forward slashes by
@​Copilot in microsoft/vstest#15088
* Remove tpv0 by @​nohwnd in
microsoft/vstest#15247
* Cache AssemblyName in ManagedNameHelper by @​Youssef1313 in
microsoft/vstest#15259
* Add ARM64 support to GetArchitectureForSource methods by @​Copilot in
microsoft/vstest#15278

### Internal fixes and updates

* Fix formatting in two files by @​ViktorHofer in
microsoft/vstest#15047
* Build TestPlatform packages in VMR by @​ViktorHofer in
microsoft/vstest#15055
* Condition property on .NET FX MSBuild by @​jaredpar in
microsoft/vstest#15054
* Migrate to awesome assertions by @​nohwnd in
microsoft/vstest#15056
* Revert "Build TestPlatform packages in VMR" by @​ViktorHofer in
microsoft/vstest#15057
* Update package Category by @​ViktorHofer in
microsoft/vstest#15058
* Revert "Write props of tests into trx" by @​nohwnd in
microsoft/vstest#15080
* Error on unsupported tfms (#​15072) by @​nohwnd in
microsoft/vstest#15073
* Use policies from testfx to align by @​nohwnd in
microsoft/vstest#15085
* Update enable-auto-merge.yml by @​nohwnd in
microsoft/vstest#15102
* Revert ignoring environment test by @​Copilot in
microsoft/vstest#15094
* unignore tests by @​Copilot in
microsoft/vstest#15093
* Update MSTest by @​Youssef1313 in
microsoft/vstest#15108
* Bump dotnet-sdk from 9.0.106 to 9.0.301 by @​dependabot[bot] in
microsoft/vstest#15179
* Use Assert.Equals by @​nohwnd in
microsoft/vstest#15181
* Run VSTest tests with MTP by @​Youssef1313 in
microsoft/vstest#15079
* Use the standard sdk for architecture switch test by @​nohwnd in
microsoft/vstest#15188
* Remove CUIT (Coded UI Test) from NuGet packages and test projects by
@​Copilot in microsoft/vstest#15177
* dump-logs? by @​nohwnd in
microsoft/vstest#15187
* Moving to version 18 by @​nohwnd in
microsoft/vstest#15209
* Update fakes version by @​drognanar in
microsoft/vstest#15227
* Microsoft.Intellitrace.Core should be taken from nuget by @​nohwnd in
microsoft/vstest#15229
* Remove MSTest.Assert.Extensions by @​Youssef1313 in
microsoft/vstest#15178
* Sourcebuild fix by @​nohwnd in
microsoft/vstest#15239
* Set dotnet_root_<arch> only when the architecture of dotnet in the
path is the same by @​nohwnd in
microsoft/vstest#15250
* Remove fakes v1 from FakesUtilities by @​drognanar in
microsoft/vstest#15251
* Update fakes dependencies by @​drognanar in
microsoft/vstest#15254
* Do half the work in GetManagedName by @​Youssef1313 in
microsoft/vstest#15255
* check Vsix only when produced by @​nohwnd in
microsoft/vstest#15261
* Set dotnet_root_<arch> always by @​nohwnd in
microsoft/vstest#15266
* Don't hardcode old vswhere version in global.json by @​akoeplinger in
microsoft/vstest#15267
* Revert dowgrade of fakes by @​nohwnd in
microsoft/vstest#15263
* Update VSSDK to version with code flow guard by @​nohwnd in
microsoft/vstest#15279
* Update Fakes to version with code flow guard by @​nohwnd in
microsoft/vstest#15273
 ... (truncated)

Commits viewable in [compare
view](microsoft/vstest@v17.14.1...v18.0.0).
</details>

[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=Microsoft.NET.Test.Sdk&package-manager=nuget&previous-version=17.14.1&new-version=18.0.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
This was referenced Oct 25, 2025
Closed
Merged
Open
Open
Merged
Merged
Merged
Open
Merged
Merged
Closed
Closed
Open
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nohwnd nohwnd nohwnd left review comments

@drognanar drognanar drognanar approved these changes

@Evangelink Evangelink Evangelink approved these changes

Assignees

@nohwnd nohwnd

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add documentation of environment variables

4 participants

@nohwnd @drognanar @Evangelink