[Housekeeping] Add MSBuild Task to Verify .NET MAUI Workload Installed on Local Machine #2266
+113
−0
There are no files selected for viewing
This file contains 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 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 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 |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFramework>$(NetVersion)</TargetFramework> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Microsoft.Build.Utilities.Core" Version="17.11.4" PrivateAssets="all"/> | ||
| </ItemGroup> | ||
|
|
||
| </Project> | ||
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| using System.Diagnostics; | ||
| using System.Text.RegularExpressions; | ||
| using Microsoft.Build.Framework; | ||
|
|
||
| namespace CommunityToolkit.Maui.BuildTasks; | ||
|
|
||
| public partial class VerifyMauiWorkloadVersionTask : Microsoft.Build.Utilities.Task | ||
| { | ||
| static readonly ProcessStartInfo processStartInfo = new() | ||
| { | ||
| FileName = "dotnet", | ||
| Arguments = "workload list", | ||
| UseShellExecute = false, | ||
| RedirectStandardOutput = true, | ||
| CreateNoWindow = true, | ||
| WorkingDirectory = AppDomain.CurrentDomain.BaseDirectory | ||
| }; | ||
|
|
||
| [Required] | ||
| public string MinimumRequiredMauiVersion { get; set; } = string.Empty; | ||
|
|
||
| public override bool Execute() | ||
| { | ||
| try | ||
| { | ||
| var dotnetOutput = GetDotnetWorkloadOutput(); | ||
| var installedMauiWorkloadVersion = ExtractMauiVersion(dotnetOutput); | ||
|
|
||
| if (string.IsNullOrEmpty(installedMauiWorkloadVersion)) | ||
| { | ||
| Log.LogError($"No MAUI workload installed/n{GenerateTroubleshootingText(MinimumRequiredMauiVersion)}"); | ||
brminnick marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return false; | ||
| } | ||
|
|
||
| var currentVersion = Version.Parse(installedMauiWorkloadVersion); | ||
| var minimumRequiredVersion = Version.Parse(MinimumRequiredMauiVersion); | ||
|
|
||
| if (currentVersion < minimumRequiredVersion) | ||
| { | ||
| Log.LogError($"The installed MAUI workload version, {installedMauiWorkloadVersion}, does not meet the minimum version required by the .NET MAUI Community Toolkit: {MinimumRequiredMauiVersion}./n{GenerateTroubleshootingText(MinimumRequiredMauiVersion)}"); | ||
brminnick marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return false; | ||
| } | ||
|
|
||
| Log.LogMessage(MessageImportance.Normal, $"MAUI workload version {installedMauiWorkloadVersion} satisfies the required version {MinimumRequiredMauiVersion}."); | ||
|
|
||
| return true; | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| Log.LogErrorFromException(ex); | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| static string GetDotnetWorkloadOutput() | ||
| { | ||
| using var process = new Process(); | ||
| process.StartInfo = processStartInfo; | ||
|
|
||
| process.Start(); | ||
| var output = process.StandardOutput.ReadToEnd(); | ||
| process.WaitForExit(); | ||
|
|
||
| return output; | ||
| } | ||
|
|
||
| static string? ExtractMauiVersion(string dotnetOutput) | ||
| { | ||
| var match = VerifyWorkloadVersion().Match(dotnetOutput); | ||
|
|
||
| return match.Success ? match.Groups[0].Value : null; | ||
| } | ||
|
|
||
| static string GenerateTroubleshootingText(in string minimumMauiVersion) => | ||
| $""" | ||
| Follow these steps to install the required .NET MAUI workload: | ||
| 1. Using your web browser, download the latest stable release of the .NET SDK and install it on your machine: https://dotnet.microsoft.com/download/dotnet | ||
| 2. After installing the latest version of .NET, using your console, use the command `dotnet workload install maui --version {minimumMauiVersion}` to update to the latest stable version of .NET MAUI \n | ||
| """; | ||
|
|
||
| [GeneratedRegex(@"(?<=Workload version: )\d+\.\d+\.\d+\.\d+")] | ||
| private static partial Regex VerifyWorkloadVersion(); | ||
| } | ||
This file contains 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 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
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.
I'm not sure if you want to use the
net8here... It's recommended to usenetstandardfor MsBuild tasks, because the project may run on IDEs and/or tools that doesn't supportnet8. For example, Visual Studio runs on top of .net framework, and usingnet 8may cause errors