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.

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

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

Copilot
Copy link
Contributor

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

- 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 <5735905+nohwnd@users.noreply.github.com>
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
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.

Co-authored-by: nohwnd <5735905+nohwnd@users.noreply.github.com>
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Error loading sessions

Retrying...

Successfully merging this pull request may close these issues.

Add documentation of environment variables
4 participants