Update WinUI setup documentation - #11759
Update WinUI setup documentation#11759Sakshi Sharma (sakshisharma150905) wants to merge 1 commit into
Conversation
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
microsoft-github-policy-service
Bot
added
the
needs-triage
|
/azp run |
|
Azure Pipelines: 1 pipeline(s) were filtered out due to trigger conditions. |
Sakshi Sharma (sakshisharma150905)
linked an issue
| * Otherwise, run the following command to install or configure Visual Studio 2022 Build Tools: | ||
|
|
||
| ``` | ||
| cd C:\winui3 | ||
| .\OneTimeSetup.cmd -Install MSBuild | ||
| ``` | ||
|
|
||
| `OneTimeSetup.cmd -Install MSBuild` always targets Visual Studio 2022 Build Tools. Do not run it | ||
| to configure an existing Visual Studio 2026 installation. |
There was a problem hiding this comment.
Is VS2022 needed at all?
There was a problem hiding this comment.
Then I recommend deleting the scripts, docs, etc. and instead have one step of steps utilizing VS2026.
| Studio installation. If initialization reports missing `Microsoft.NET.Sdk` or | ||
| `Microsoft.Windows.UI.Xaml.*.targets` files under a Visual Studio installation, use Visual Studio | ||
| Installer to add the components from `.vsconfig` to that installation. |
There was a problem hiding this comment.
But you just said those files were for VS2026--how does this resolve the errors when using VS2022 build tools?
| with Visual Studio 2026 if all necessary components are installed. | ||
| * `OneTimeSetup.cmd -Install MSBuild` installs or modifies Visual Studio 2022 Build Tools. To use | ||
| Visual Studio 2026, import the repository's `.vsconfig` file into that installation instead. | ||
| * `init.cmd` may select an installed Visual Studio Build Tools instance instead of a full Visual |
There was a problem hiding this comment.
The init script installs build tools. So this sentence is wrong.
Mike Crider (codendone)
left a comment
Mike Crider (codendone)
left a comment
There was a problem hiding this comment.
More changes are needed overall, but this change is a step forward and I think is an important fix to approve as a separate incremental improvement.
| Visual Studio 2026, import the repository's `.vsconfig` file into that installation instead. | ||
| * `init.cmd` may select an installed Visual Studio Build Tools instance instead of a full Visual | ||
| Studio installation. If initialization reports missing `Microsoft.NET.Sdk` or | ||
| `Microsoft.Windows.UI.Xaml.*.targets` files under a Visual Studio installation, use Visual Studio |
There was a problem hiding this comment.
In my recent test, I hit this Microsoft.Windows.UI.Xaml.*.targets file issue even when using OneTimeSetup.cmd on a clean machine (using the .vsconfig file). I think the .vsconfig file needs to be updated to add some missing component(s) (presumably caused by some changes to VS components). I think it is fine to do that .vsconfig update as a separate PR.
6 participants
Description
Updates the public WinUI build documentation following the migration from
winui3/maintomain.This change:
README.mdandGettingStarted.mdto reference themainbranch.OneTimeSetup.cmd -Install MSBuildinstalls or modifies Visual Studio 2022 Build Tools..vsconfigfile.init.cmdmay select an installed Build Tools instance and explains how to resolve missingMicrosoft.NET.SdkorMicrosoft.Windows.UI.Xaml.*.targetserrors.Only the public documentation is updated; no setup scripts, workflows, or build behavior are changed.