Requirements for building toolkit nuget package locally

[arcadiogarcia]

I am trying to build the NuGet package locally so I can start consuming some changes before they are available in the official Toolkit builds. I haven't found any information in the wiki about building the nuget package locally, and I saw that the Azure DevOps pipeline just runs these commands:

.\build\build.ps1 -Target Build
.\build\build.ps1 -Target Package

However, if I try to run the first one in an elevated terminal locally, the build process eventually stops with the following error:

       "C:\Users\arcad\source\repos\WindowsCommunityToolkit\Windows Community Toolkit.sln" (Build target) (1) ->
       "C:\Users\arcad\source\repos\WindowsCommunityToolkit\UnitTests\UnitTests.NetCore\UnitTests.NetCore.csproj" (default targe
       t) (25) ->
       "C:\Users\arcad\source\repos\WindowsCommunityToolkit\UnitTests\UnitTests.NetCore\UnitTests.NetCore.csproj" (Build target)
        (25:3) ->
       "C:\Users\arcad\source\repos\WindowsCommunityToolkit\Microsoft.Toolkit.Mvvm\Microsoft.Toolkit.Mvvm.csproj" (default targe
       t) (15:8) ->
       "C:\Users\arcad\source\repos\WindowsCommunityToolkit\Microsoft.Toolkit.Mvvm.SourceGenerators\Microsoft.Toolkit.Mvvm.Sourc
       eGenerators.csproj" (default target) (26:5) ->
       (CoreCompile target) ->
         C:\Users\arcad\source\repos\WindowsCommunityToolkit\Microsoft.Toolkit.Mvvm.SourceGenerators\ComponentModel\ObservablePr
       opertyGenerator.SyntaxReceiver.cs(53,30): error CS1572: XML comment has a param tag for 'LeadingTrivia', but there is no
       parameter by that name [C:\Users\arcad\source\repos\WindowsCommunityToolkit\Microsoft.Toolkit.Mvvm.SourceGenerators\Micro
       soft.Toolkit.Mvvm.SourceGenerators.csproj]
         C:\Users\arcad\source\repos\WindowsCommunityToolkit\Microsoft.Toolkit.Mvvm.SourceGenerators\ComponentModel\ObservablePr
       opertyGenerator.SyntaxReceiver.cs(54,30): error CS1572: XML comment has a param tag for 'FieldSymbol', but there is no pa
       rameter by that name [C:\Users\arcad\source\repos\WindowsCommunityToolkit\Microsoft.Toolkit.Mvvm.SourceGenerators\Microso
       ft.Toolkit.Mvvm.SourceGenerators.csproj]

[followed by similar XML comment errors]

I haven't modified any files in the MVVM project and as far as I can tell the comments are correct and the parameters actually exist. The errors are all regarding params in record constructors. which are not detected correctly when checking the validity of the xml comments. This makes me think the build command is running with an incorrect .net version which has trouble recognizing the record completely. (For what is worth, I can build the solution and run the test app from my VS2019 installation just fine)

Before I dig deeper, are there any official steps for building the NuGet package that I have missed? Is there a list of requirements / recommended tooling versions? Or did I miss some build step that sets up the build tools? I'd appreciate any pointers!

[michael-hawker]

@arcadiogarcia we should have requirements documented in our Wiki, though running build.bat script as you did should have worked (though we do have a wiki issue tracking providing better guidance). There is a PR about removing stray warnings #4125, but it builds in the CI and locally normally so there could be some other environment thing flagging more issues maybe? (FYI @Sergio0694)

If you're just trying to pull the latest main changes though, we have a feed that has the latest toolkit builds already built. You can read about that in the Preview Packages Wiki page here.

[Sergio0694]

Mmmh that's weird, but then again I'm not really familiar with the build script (haven't used it myself).
@arcadiogarcia if you just open the .NET solution filter and try building that entire solution, does the build work fine for you?
I just reproed and that does build fine on my end (both with VS2019 latest and VS2022 Preview 3), so I'm thinking it might just be something weird going on with the build script. I remember having some issues with it in the past as well when I tried using it.