[msbuild/dotnet] Add support for listing the devices and simulators available to run on. #24279
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -16,11 +16,38 @@ Builds the source code within a project and all dependencies. | |||||
|
|
||||||
| Removes all files generated by the build process. | ||||||
|
|
||||||
| ## ComputeAvailableDevices | ||||||
|
|
||||||
| Queries and returns a list of available iOS or tvOS devices and simulators that can be used with `dotnet run`. | ||||||
|
|
||||||
| This target is called automatically by the .NET SDK's `dotnet run` command to | ||||||
| support device selection via the `--device` option. It returns a `@(Devices)`` | ||||||
|
There was a problem hiding this comment. There's a double backtick after
Suggested change
|
||||||
| item group where each device has the following metadata: | ||||||
|
|
||||||
| - **Description**: The name of the device (e.g., "iPhone 16 - iOS 26.0" for simulators, "My iPhone 16" for physical devices) | ||||||
| - **Type**: Either "Device" or "Simulator" | ||||||
| - **OSVersion**: The OS version if the device | ||||||
|
There was a problem hiding this comment. Grammar error: should be "The OS version of the device" instead of "The OS version if the device".
Suggested change
|
||||||
| - **UDID**: The UDID of the device | ||||||
|
|
||||||
| For example, to list all available devices: | ||||||
|
|
||||||
| ```shell | ||||||
| $ dotnet build -t:ComputeAvailableDevices | ||||||
| ``` | ||||||
|
|
||||||
| This target is part of the [.NET SDK device selection specification](https://github.com/dotnet/sdk/blob/2b9fc02a265c735f2132e4e3626e94962e48bdf5/documentation/specs/dotnet-run-for-maui.md) and enables commands like: | ||||||
|
|
||||||
| ```shell | ||||||
| $ dotnet run --device UDID | ||||||
| ``` | ||||||
|
|
||||||
| Added in .NET 11. | ||||||
|
|
||||||
| ## Run | ||||||
|
|
||||||
| Builds the source code within a project and all dependencies, and then deploys and runs it | ||||||
| on a default simulator/device. A specific deployment target can be set by using the `$(Device)` property. | ||||||
|
|
||||||
| ```dotnetcli | ||||||
| dotnet build -t:Run project.csproj -p:Device=$(MY_DEVICE_UDID) | ||||||
| ``` | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -2407,7 +2407,8 @@ | |||||
| <RelativeMlaunchPath Condition="'$(RelativeMlaunchPath)' == ''">$(XamarinRelativeSdkRootDirectory)tools\bin\mlaunch</RelativeMlaunchPath> | ||||||
| <_RelativeMlaunchPath Condition="'$(_RelativeMlaunchPath)' == ''">$(RelativeMlaunchPath)</_RelativeMlaunchPath> | ||||||
|
|
||||||
| <!-- Try to keep _DeviceName working for a while yet --> | ||||||
| <Device Condition="'$(Device)' == ''">$(_DeviceName)</Device> | ||||||
|
Comment on lines
-2410
to
+2411
Member
There was a problem hiding this comment. Do you need to keep |
||||||
| </PropertyGroup> | ||||||
|
|
||||||
| <Target | ||||||
|
|
@@ -2445,7 +2446,7 @@ | |||||
| <GetMlaunchArguments | ||||||
| SessionId="$(BuildSessionId)" | ||||||
| AppManifestPath="$(_AppBundleManifestPath)" | ||||||
| DeviceName="$(Device)" | ||||||
| InstallApp="$(_AppBundlePath)" | ||||||
| MlaunchPath="$(MlaunchPath)" | ||||||
| SdkDevPath="$(_SdkDevPath)" | ||||||
|
|
@@ -2558,6 +2559,33 @@ | |||||
| </PropertyGroup> | ||||||
| </Target> | ||||||
|
|
||||||
| <!-- | ||||||
| *********************************************************************************************** | ||||||
| ComputeAvailableDevices | ||||||
| Target that queries available devices and simulators. | ||||||
| This target is called by 'dotnet run' to support device selection. | ||||||
| Returns @(Devices) items with metadata: ??????? | ||||||
|
There was a problem hiding this comment. The comment states "Returns @(Devices) items with metadata: ???????" which appears to be a placeholder that was not filled in. The metadata should be documented here (Description, Type, OSVersion, UDID) similar to what's in the build-targets.md documentation.
Suggested change
|
||||||
| See: https://github.com/dotnet/sdk/blob/2b9fc02a265c735f2132e4e3626e94962e48bdf5/documentation/specs/dotnet-run-for-maui.md | ||||||
| *********************************************************************************************** | ||||||
| --> | ||||||
| <Target Name="ComputeAvailableDevices" | ||||||
| DependsOnTargets="_DetectSdkLocations;_GenerateBundleName;" | ||||||
| Returns="@(Devices)"> | ||||||
| <GetAvailableDevices | ||||||
| Condition="'$(IsMacEnabled)' == 'true'" | ||||||
| SessionId="$(BuildSessionId)" | ||||||
|
Comment on lines
+2577
to
+2578
Member
There was a problem hiding this comment. That is a question... Will this work on Windows? Ideally, it could, but that could be future PR. |
||||||
| AppBundleManifestPath="$(_AppBundleManifestPath)" | ||||||
| RuntimeIdentifier="$(RuntimeIdentifier)" | ||||||
| SdkDevPath="$(_SdkDevPath)" | ||||||
| TargetFrameworkMoniker="$(_ComputedTargetFrameworkMoniker)" | ||||||
| > | ||||||
| <Output TaskParameter="Devices" ItemName="Devices" /> | ||||||
| <Output TaskParameter="DiscardedDevices" ItemName="DiscardedDevices" /> | ||||||
| </GetAvailableDevices> | ||||||
| </Target> | ||||||
|
|
||||||
| <!-- | ||||||
| Add a 'global using nfloat = System.Runtime.InteropServices.NFloat' to ease migration from Xamarin. | ||||||
| We're not using a the Usings item group, because this code shows a warning in .NET 7: | ||||||
|
|
||||||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistent code formatting: The second command example should use backticks for consistency with the first example. Change
-p:Device=0000-aaaabbbbto`-p:Device=0000-aaaabbbb`.