Skip to content

Document launch profiles for dotnet run - #55785

Merged
BillWagner merged 3 commits into
dotnet:mainfrom
tannergooding:tannergooding-document-launch-profiles
Sep 4, 2026
Merged

Document launch profiles for dotnet run#55785
BillWagner merged 3 commits into
dotnet:mainfrom
tannergooding:tannergooding-document-launch-profiles

Conversation

@tannergooding

@tannergooding tannergooding commented Aug 31, 2026

Copy link
Copy Markdown
Member

Documents the general launchSettings.json contract supported by the .NET SDK and dotnet run, including profile discovery and selection, supported profile types and properties, precedence, path and variable expansion, and runtime configuration links.

Clarifies where Visual Studio, debugger, desktop-project, and workload-specific behavior extends or differs from the CLI contract. Links file-based app launch profiles and DOTNET_LAUNCH_PROFILE back to the general reference.

Note

This PR was created with the assistance of GitHub Copilot.


Internal previews

File Preview link
docs/core/sdk/file-based-apps.md Learn preview
docs/core/tools/dotnet-environment-variables.md Learn preview
docs/core/tools/dotnet-run.md Learn preview

Build report

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@tannergooding

Copy link
Copy Markdown
Member Author

CC. @baronfel noticed we were missing docs around this and everything essentially just linked to ASP.NET instead. So this covers what launchSettings.json generally supports for all projects and links to the relevant settings and domain specific settings.

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

Copilot review overview

🟢 Approval recommended

Review tier: Lite
Findings: None

What changed in this PR

This PR documents the launchSettings.json contract that the .NET SDK and dotnet run support, including how profiles are discovered and selected, which profile types and properties the CLI recognizes, how environment variables and argument precedence work, and where Visual Studio/debugger behavior differs from the CLI contract.

Changes:

  • Added a new Launch profiles section to dotnet run documentation that defines profile structure, selection behavior, supported commandName values, supported properties, and Visual Studio comparisons.
  • Updated --launch-profile and environment variable precedence documentation to point back to the new consolidated reference.
  • Linked file-based app launch profile docs to the general dotnet run launch profile reference, and updated related cross-references.
File Description
docs/​core/​tools/​dotnet-run.md Adds comprehensive dotnet run launch profile reference and updates CLI option/env-var documentation to align with it.
docs/​core/​tools/​dotnet-environment-variables.md Updates DOTNET_LAUNCH_PROFILE section to deep-link to the new launch profiles reference.
docs/​core/​sdk/​file-based-apps.md Links file-based app launch profiles section back to the general dotnet run launch profiles reference.

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

@baronfel baronfel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Absolutely lovely - thank you for taking the time.

Comment thread docs/core/tools/dotnet-run.md
Comment thread docs/core/tools/dotnet-run.md Outdated
tannergooding and others added 2 commits September 2, 2026 12:55
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@tannergooding

Copy link
Copy Markdown
Member Author

The backport to .NET 11 landed (thanks @baronfel, @jjonescz) so I did one last update and the docs now indicate In .NET 11 and later ...

@gewarren this should be good for final sign-off and merge.

@BillWagner BillWagner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Adding final approval.

@BillWagner
BillWagner merged commit 6b94bd8 into dotnet:main Sep 4, 2026
10 checks passed
Sign up for free to 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.

6 participants