Scripts separate flag for installing MAUI workload

Author: jfversluis

eng/build.ps1

@@ -44,6 +44,7 @@ function Get-Help() {
   Write-Host "Libraries settings:"
   Write-Host "  -testnobuild            Skip building tests when invoking -test."
   Write-Host "  -buildExtension         Build the VS Code extension."
+  Write-Host "  -restore-maui           Restore the MAUI workload after restore (only on Windows/macOS)."
   Write-Host ""
 
   Write-Host "Command-line arguments not listed above are passed through to MSBuild."
@@ -111,11 +112,11 @@ Write-Host "& `"$PSScriptRoot/common/build.ps1`" $arguments"
 Invoke-Expression "& `"$PSScriptRoot/common/build.ps1`" $arguments"
 $buildExitCode = $LASTEXITCODE
 
-# Install MAUI workload after restore if -restore was passed
+# Install MAUI workload after restore if -restore-maui was passed
 # Only on Windows and macOS (MAUI doesn't support Linux)
-$restoreRequested = ($PSBoundParameters.ContainsKey('restore') -or $arguments -like '*-restore*')
+$restoreMauiPassed = $properties -contains "-restore-maui"
 $isWindowsOrMac = ($IsWindows -or $IsMacOS -or (-not (Get-Variable -Name IsWindows -ErrorAction SilentlyContinue)))
-if ($restoreRequested -and $buildExitCode -eq 0 -and $isWindowsOrMac) {
+if ($restoreMauiPassed -and $buildExitCode -eq 0 -and $isWindowsOrMac) {
   Write-Host ""
   Write-Host "Installing MAUI workload into local .dotnet..."
 

eng/build.sh

@@ -46,6 +46,7 @@ usage()
   echo "Libraries settings:"
   echo "  --testnobuild              Skip building tests when invoking -test."
   echo "  --build-extension          Build the VS Code extension."
+  echo "  --restore-maui             Restore the MAUI workload after restore (only on macOS)."
   echo ""
 
   echo "Command line arguments starting with '/p:' are passed through to MSBuild."
@@ -55,6 +56,7 @@ usage()
 
 arguments=''
 extraargs=''
+restore_maui=false
 
 # Check if an action is passed in
 declare -a actions=("b" "build" "r" "restore" "rebuild" "testnobuild" "sign" "publish" "clean" "t" "test" "build-extension")
@@ -142,6 +144,11 @@ while [[ $# > 0 ]]; do
       shift 1
       ;;
 
+     -restore-maui)
+      restore_maui=true
+      shift 1
+      ;;
+
      *)
       extraargs="$extraargs $1"
       shift 1
@@ -161,9 +168,9 @@ arguments="$arguments $extraargs"
 "$scriptroot/common/build.sh" $arguments
 buildExitCode=$?
 
-# Install MAUI workload after restore if --restore was passed
+# Install MAUI workload after restore if --restore-maui was passed
 # Only on macOS (MAUI doesn't support Linux, Windows uses .cmd)
-if [[ "$arguments" == *"-restore"* ]] && [ $buildExitCode -eq 0 ]; then
+if [ "$restore_maui" = true ] && [ $buildExitCode -eq 0 ]; then
   # Check if we're on macOS
   if [[ "$(uname -s)" == "Darwin" ]]; then
     echo ""

playground/AspireWithMaui/README.md

@@ -5,98 +5,114 @@ This playground demonstrates .NET Aspire integration with .NET MAUI applications
 ## Prerequisites
 
 - .NET 10 or later
-- .NET MAUI workload (will be installed automatically by the restore script)
+- .NET MAUI workload
 
 ## Getting Started
 
 ### Initial Setup
 
-Before building or running the playground, you must restore dependencies and install the MAUI workload:
+Before building or running the playground, you must restore dependencies and install the MAUI workload.
+
+Run the following commands from the repository root:
 
 **Windows:**
 ```cmd
-restore.cmd
+.\restore.cmd -restore-maui
 ```
 
 **Linux/macOS:**
 ```bash
-./restore.sh
+./restore.sh --restore-maui
 ```
 
-This script will:
-1. Run the main Aspire restore to set up the local .dotnet SDK
-2. Install the MAUI workload into the local `.dotnet` folder (does not affect your global installation)
+This will:
+1. Restore all Aspire dependencies and set up the local .dotnet SDK
+2. Install the MAUI workload into the repository's local `.dotnet` folder (does not affect your global installation)
 
 > **Note:** The MAUI workload is installed only in the repository's local `.dotnet` folder and will not interfere with your system-wide .NET installation.
+> This also means that you will still need to do this even if you have the MAUI workload already installed in your system-wide .NET installation.
 
 ### Running the Playground
 
-After running the restore script, you can build and run the playground:
+After running the restore script with `-restore-maui`, you can build and run the playground:
 
 **Using Visual Studio:**
-1. Run `restore.cmd` (Windows) or `./restore.sh` (Linux/macOS)
+1. Run `.\restore.cmd -restore-maui` from the repository root (Windows)
 2. Open `AspireWithMaui.AppHost` project
 3. Set it as the startup project
 4. Press F5 to run
 
 **Using VS Code:**
-1. Run `restore.cmd` (Windows) or `./restore.sh` (Linux/macOS)
+1. Run `.\restore.cmd -restore-maui` (Windows) or `./restore.sh --restore-maui` (Linux/macOS) from the repository root
 2. From the repository root, run: `./start-code.sh` or `start-code.cmd`
 3. Open the `AspireWithMaui` folder
 4. Use the debugger to run the AppHost
 
 **Using Command Line:**
-1. Run `restore.cmd` (Windows) or `./restore.sh` (Linux/macOS)
-2. Navigate to `AspireWithMaui.AppHost` directory
+1. Run `.\restore.cmd -restore-maui` (Windows) or `./restore.sh --restore-maui` (Linux/macOS) from the repository root
+2. Navigate to `playground/AspireWithMaui/AspireWithMaui.AppHost` directory
 3. Run: `dotnet run`
 
 ## What's Included
 
 - **AspireWithMaui.AppHost** - The Aspire app host that orchestrates all services
-- **AspireWithMaui.MauiClient** - A .NET MAUI application that connects to the backend
+- **AspireWithMaui.MauiClient** - A .NET MAUI application that connects to the backend (Windows platform only in this playground)
 - **AspireWithMaui.WeatherApi** - An ASP.NET Core Web API providing weather data
 - **AspireWithMaui.ServiceDefaults** - Shared service defaults for non-MAUI projects
 - **AspireWithMaui.MauiServiceDefaults** - Shared service defaults specific to MAUI projects
 
 ## Features Demonstrated
 
-### MAUI Platform Support
-The playground demonstrates Aspire's ability to manage MAUI apps across multiple platforms:
-- Windows
-- Android
-- iOS
-- macCatalyst
+### MAUI Windows Platform Support
+The playground demonstrates Aspire's ability to manage MAUI apps on Windows:
+- Configures the MAUI app with `.AddMauiWindows()`
+- Automatically detects the Windows target framework from the project file
+- Sets up dev tunnels for MAUI app communication with backend services
 
 ### OpenTelemetry Integration
 The MAUI client uses OpenTelemetry to send traces and metrics to the Aspire dashboard via dev tunnels.
 
 ### Service Discovery
 The MAUI app discovers and connects to backend services (WeatherApi) using Aspire's service discovery.
 
-### Multi-Platform Development
-The AppHost shows how to:
-- Configure different platforms with `.WithWindows()`, `.WithAndroid()`, `.WithiOS()`, `.WithMacCatalyst()`
-- Set up dev tunnels for MAUI app communication
-- Reference backend services from MAUI apps
+### Future Platform Support
+The architecture is designed to support additional platforms (Android, iOS, macCatalyst) through:
+- `.AddMauiAndroid()`, `.AddMauiIos()`, `.AddMauiMacCatalyst()` extension methods (coming in future updates)
+- Parallel extension patterns for each platform
 
 ## Troubleshooting
 
 ### "MAUI workload not detected" Warning
 If you see this warning in the Aspire dashboard:
-1. Make sure you ran `restore.cmd` or `./restore.sh` in the `playground/AspireWithMaui` directory
+1. Make sure you ran `.\restore.cmd -restore-maui` or `./restore.sh --restore-maui` from the repository root
 2. The warning indicates the MAUI workload is not installed in the local `.dotnet` folder
-3. Re-run the restore script to install it
+3. Re-run the restore command with the `-restore-maui` or `--restore-maui` flag
 
 ### Build Errors
 If you encounter build errors:
-1. Ensure you ran the restore script first
+1. Ensure you ran the restore script with the MAUI flag first: `.\restore.cmd -restore-maui`
 2. Make sure you're using .NET 10 RC or later
 3. Try running `dotnet build` from the repository root first
 
 ### Platform-Specific Issues
 - **Windows**: Requires Windows 10 build 19041 or higher for WinUI support
-- **Android**: Requires Android SDK and emulator/device
-- **iOS/macCatalyst**: Requires macOS with Xcode installed
+- **Android**: Not yet implemented in this playground (coming soon)
+- **iOS/macCatalyst**: Not yet implemented in this playground (coming soon)
+
+## Current Status
+
+✅ **Implemented:**
+- Windows platform support via `AddMauiWindows()`
+- Automatic Windows TFM detection from project file
+- Dev tunnel configuration for MAUI-to-backend communication
+- Service discovery integration
+- OpenTelemetry integration
+
+🚧 **Coming Soon:**
+- Android platform support
+- iOS platform support
+- macCatalyst platform support
+- Multi-platform simultaneous debugging
 
 ## Learn More
 

playground/AspireWithMaui/restore.cmd

@@ -7,9 +7,9 @@ ECHO Restoring AspireWithMaui Playground
 ECHO ============================================================
 ECHO.
 
-REM Run the main Aspire restore (which now includes MAUI workload installation)
-ECHO Running main Aspire restore (includes MAUI workload installation)...
-CALL "%~dp0..\..\restore.cmd"
+REM Run the main Aspire restore with MAUI workload installation
+ECHO Running main Aspire restore with MAUI workload installation...
+CALL "%~dp0..\..\restore.cmd" -installMaui
 IF ERRORLEVEL 1 (
     ECHO ERROR: Failed to restore Aspire. Please check the output above.
     EXIT /B 1

playground/AspireWithMaui/restore.sh

@@ -12,9 +12,9 @@ echo ""
 script_dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 repo_root="$script_dir/../.."
 
-# Run the main Aspire restore (which now includes MAUI workload installation)
-echo "Running main Aspire restore (includes MAUI workload installation)..."
-"$repo_root/restore.sh"
+# Run the main Aspire restore with MAUI workload installation
+echo "Running main Aspire restore with MAUI workload installation..."
+"$repo_root/restore.sh" --install-maui
 
 echo ""
 echo "============================================================"