Add CommunityToolkit.Maui.BindingExtensions NuGet package (#22)

Moves binding build targets and tasks into a NuGet package so that each slim binding does not need to copy and build the eng (now src) folder. Includes a handful of fixes for incremental builds and multi-targeting builds running in parallel.
CommunityToolkit · Jun 7, 2024 · ab96f71 · ab96f71
1 parent b6bdb35
commit ab96f71
Show file tree

Hide file tree

Showing 30 changed files with 302 additions and 192 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -38,24 +38,37 @@ jobs:
       - name: Create logs dir
         run: mkdir -p ${{ runner.temp }}/logs/
 
+      - name: Create local nupkg dir
+        run: mkdir -p ./src/CommunityToolkit.Maui.BindingExtensions/bin/Release
+
       - name: Build and test build tasks
-        working-directory: ./eng
+        working-directory: ./src
         run: >-
-          dotnet test Microsoft.Maui.BindingExtensions.Build.Tasks.sln
+          dotnet test CommunityToolkit.Maui.BindingExtensions.sln
           --logger trx --results-directory ${{ runner.temp }}/logs/TestResults-build-tasks
           -bl:${{ runner.temp }}/logs/build-tasks.binlog
 
+      - name: Pack build tasks
+        working-directory: ./src/CommunityToolkit.Maui.BindingExtensions
+        run: dotnet pack CommunityToolkit.Maui.BindingExtensions.csproj -bl:${{ runner.temp }}/logs/build-tasks-pack.binlog
+
+      - name: Upload nupkg
+        uses: actions/upload-artifact@v4
+        with:
+          name: nupkg
+          path: ./src/CommunityToolkit.Maui.BindingExtensions/bin/Release/*.nupkg
+
       - name: Build facebook
         working-directory: ./facebook
-        run: dotnet build -m:1 -bl:${{ runner.temp }}/logs/facebook.binlog
+        run: dotnet build -bl:${{ runner.temp }}/logs/facebook.binlog
 
       - name: Build firebase
         working-directory: ./firebase/macios
-        run: dotnet build -m:1 -bl:${{ runner.temp }}/logs/firebase-macios.binlog
+        run: dotnet build -bl:${{ runner.temp }}/logs/firebase-macios.binlog
 
       - name: Build googlecast
         working-directory: ./googlecast/macios
-        run: dotnet build -m:1 -bl:${{ runner.temp }}/logs/googlecast-macios.binlog
+        run: dotnet build -bl:${{ runner.temp }}/logs/googlecast-macios.binlog
 
       - name: Upload logs
         uses: actions/upload-artifact@v4

diff --git a/.gitignore b/.gitignore
@@ -403,7 +403,7 @@ FodyWeavers.xsd
 
 xcuserdata/
 
-build/
+**/native/build/
 .build/
 *.xcframework
 Pods/

diff --git a/eng/Directory.Build.props → Directory.Build.props b/eng/Directory.Build.props → Directory.Build.props
@@ -3,7 +3,8 @@
 
   <PropertyGroup>
     <LangVersion>latest</LangVersion>
-    <MSBuildPackageReferenceVersion>17.9.5</MSBuildPackageReferenceVersion>
+    <MSBuildPackageVersion>17.9.5</MSBuildPackageVersion>
+    <BindingExtPackageVersion>0.0.1-pre1</BindingExtPackageVersion>
   </PropertyGroup>
 
 </Project>
diff --git a/README.md b/README.md
@@ -100,9 +100,9 @@ Install prerequisites:
 
 The goal is to have bindings and samples building 100% through normal MSBuild invocations.
 
-Each .NET Binding project contains some additional MSBuild logic to help obtain and build the native SDK dependencies along with the native slim binding project. In some cases, the target may also download native SDKs if they are not already present. In this way, the expected native artefacts are available in the expected working directories.
+Each .NET Binding project contains some additional MSBuild logic to help obtain and build the native SDK dependencies along with the native slim binding project. In some cases, the target may also download native SDKs if they are not already present. In this way, the expected native artifacts are available in the expected working directories.
 
-In the [```eng/```](/eng/) folder you will find [```Common.android.targets```](/eng/Common.android.targets) and [```Common.macios.targets```](/eng/Common.macios.targets) files which contain some custom build targets to help with this, and are imported into the binding projects.
+In the [```src/```](/src/) folder you will find a solution with custom build tasks/targets to help with this.  These build extensions are available in a CommunityToolkit.Maui.BindingExtensions NuGet package that the binding projects reference.
 
 Android binding projects generate the API definition automatically taking into account any optional manual modifications like those implemented via the [```Metadata.xml```](https://learn.microsoft.com/xamarin/android/platform/binding-java-library/customizing-bindings/java-bindings-metadata#metadataxml-transform-file) transform file. 
 

diff --git a/build/nuget.png b/build/nuget.png
diff --git a/eng/Common.macios.targets b/eng/Common.macios.targets
diff --git a/eng/Common.targets b/eng/Common.targets
diff --git a/...ft.Maui.BindingExtensions.Build.Tasks/Microsoft.Maui.BindingExtensions.Build.Tasks.csproj b/...ft.Maui.BindingExtensions.Build.Tasks/Microsoft.Maui.BindingExtensions.Build.Tasks.csproj
diff --git a/facebook/android/Facebook.Android.Binding/Facebook.Android.Binding.csproj b/facebook/android/Facebook.Android.Binding/Facebook.Android.Binding.csproj
@@ -8,6 +8,10 @@
     <AndroidGenerateResourceDesigner>false</AndroidGenerateResourceDesigner>
   </PropertyGroup>
 
+  <ItemGroup>
+    <PackageReference Include="CommunityToolkit.Maui.BindingExtensions" Version="$(BindingExtPackageVersion)" />
+  </ItemGroup>
+
   <!-- Metadata applicable to @(AndroidLibrary) will be used if set -->
   <ItemGroup>
     <GradleProjectReference Include="../native" >
@@ -17,5 +21,4 @@
     </GradleProjectReference>
   </ItemGroup>
 
-  <Import Project="$(MSBuildThisFileDirectory)..\..\..\eng\Common.android.targets" />
 </Project>
diff --git a/facebook/macios/Facebook.MaciOS.Binding/Facebook.MaciOS.Binding.csproj b/facebook/macios/Facebook.MaciOS.Binding/Facebook.MaciOS.Binding.csproj
@@ -7,10 +7,11 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <ObjcBindingApiDefinition Include="ApiDefinitions.cs"/>
+    <PackageReference Include="CommunityToolkit.Maui.BindingExtensions" Version="$(BindingExtPackageVersion)" />
   </ItemGroup>
 
   <ItemGroup>
+    <ObjcBindingApiDefinition Include="ApiDefinitions.cs"/>
     <XcodeProjectReference Include="../native/MauiFacebook.xcodeproj">
       <SchemeName>MauiFacebook</SchemeName>
       <SharpieNamespace>Facebook</SharpieNamespace>
@@ -21,5 +22,4 @@
     </XcodeProjectReference>
   </ItemGroup>
 
-  <Import Project="$(MSBuildThisFileDirectory)..\..\..\eng\Common.macios.targets" />
 </Project>
diff --git a/facebook/macios/native/MauiFacebook.xcodeproj/project.pbxproj b/facebook/macios/native/MauiFacebook.xcodeproj/project.pbxproj
@@ -404,8 +404,8 @@
 			isa = XCRemoteSwiftPackageReference;
 			repositoryURL = "https://github.com/facebook/facebook-ios-sdk";
 			requirement = {
-				kind = upToNextMajorVersion;
-				minimumVersion = 14.1.0;
+				kind = exactVersion;
+				version = 16.3.1;
 			};
 		};
 /* End XCRemoteSwiftPackageReference section */

diff --git a/...s/native/MauiFacebook.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved b/...s/native/MauiFacebook.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
@@ -6,8 +6,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/facebook/facebook-ios-sdk",
       "state" : {
-        "revision" : "c19607d535864533523d1f437c84035e5fb101cf",
-        "version" : "14.1.0"
+        "revision" : "3fe31c168903759de1c5752d12856c5c437c6862",
+        "version" : "16.3.1"
       }
     }
   ],

diff --git a/firebase/macios/Firebase.MaciOS.Binding/Firebase.MaciOS.Binding.csproj b/firebase/macios/Firebase.MaciOS.Binding/Firebase.MaciOS.Binding.csproj
@@ -8,10 +8,11 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <ObjcBindingApiDefinition Include="ApiDefinitions.cs" />
+    <PackageReference Include="CommunityToolkit.Maui.BindingExtensions" Version="$(BindingExtPackageVersion)" />
   </ItemGroup>
 
   <ItemGroup>
+    <ObjcBindingApiDefinition Include="ApiDefinitions.cs" />
     <XcodeProjectReference Include="../native/MauiFirebase.xcodeproj">
       <SchemeName>MauiFirebase</SchemeName>
       <SharpieNamespace>Firebase</SharpieNamespace>
@@ -22,5 +23,4 @@
     </XcodeProjectReference>
   </ItemGroup>
 
-  <Import Project="$(MSBuildThisFileDirectory)..\..\..\eng\Common.macios.targets" />
 </Project>
diff --git a/googlecast/macios/GoogleCast.Binding/GoogleCast.Binding.csproj b/googlecast/macios/GoogleCast.Binding/GoogleCast.Binding.csproj
@@ -5,15 +5,15 @@
     <ImplicitUsings>true</ImplicitUsings>
     <IsBindingProject>true</IsBindingProject>
 
-    <XcodeBuildMacCatalyst>False</XcodeBuildMacCatalyst>
     <BuildXcodeProjectsDependsOnTargets>$(BuildXcodeProjectsDependsOnTargets);NativeDependencies</BuildXcodeProjectsDependsOnTargets>
   </PropertyGroup>
 
   <ItemGroup>
-    <ObjcBindingApiDefinition Include="ApiDefinitions.cs" />
+    <PackageReference Include="CommunityToolkit.Maui.BindingExtensions" Version="$(BindingExtPackageVersion)" />
   </ItemGroup>
 
   <ItemGroup>
+    <ObjcBindingApiDefinition Include="ApiDefinitions.cs" />
     <XcodeProjectReference Include="../native/MauiGoogleCast.xcodeproj">
       <SchemeName>MauiGoogleCast</SchemeName>
       <SharpieNamespace>GoogleCast</SharpieNamespace>
@@ -37,5 +37,4 @@
     <Exec Command="unzip -q -o -d $([System.IO.Path]::GetFullPath($(MSBuildProjectDirectory)/../native/build/deps)) @(GoogleCastiOSSdkArchives)" />
   </Target>
 
-  <Import Project="$(MSBuildThisFileDirectory)..\..\..\eng\Common.macios.targets" />
 </Project>
diff --git a/nuget.config b/nuget.config
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <packageSources>
+    <add key="maui-binding-extensions" value="https://pkgs.dev.azure.com/xamarin/public/_packaging/maui-binding-extensions/nuget/v3/index.json" />
+    <!--add key="local" value="src/CommunityToolkit.Maui.BindingExtensions/bin/Release/" /-->
+  </packageSources>
+</configuration>
diff --git a/...sions.Build.Tests/BindingToolTaskTests.cs → ...gExtensions.Tests/BindingToolTaskTests.cs b/...sions.Build.Tests/BindingToolTaskTests.cs → ...gExtensions.Tests/BindingToolTaskTests.cs
@@ -1,8 +1,8 @@
 using FluentAssertions;
-using Microsoft.Maui.BindingExtensions.Build.Tasks;
+using CommunityToolkit.Maui.BindingExtensions;
 using NUnit.Framework;
 
-namespace Microsoft.Maui.BindingExtensions.Build.Tests
+namespace CommunityToolkit.Maui.BindingExtensions.Tests
 {
     [TestFixture]
     public class BindingToolTaskTests

diff --git a/...Maui.BindingExtensions.Build.Tests.csproj → ...olkit.Maui.BindingExtensions.Tests.csproj b/...Maui.BindingExtensions.Build.Tests.csproj → ...olkit.Maui.BindingExtensions.Tests.csproj
@@ -10,15 +10,15 @@
 
   <ItemGroup>
     <PackageReference Include="FluentAssertions" Version="6.12.0" />
-    <PackageReference Include="Microsoft.Build.Framework" Version="$(MSBuildPackageReferenceVersion)" />
-    <PackageReference Include="Microsoft.Build.Tasks.Core" Version="$(MSBuildPackageReferenceVersion)" />
+    <PackageReference Include="Microsoft.Build.Framework" Version="$(MSBuildPackageVersion)" />
+    <PackageReference Include="Microsoft.Build.Tasks.Core" Version="$(MSBuildPackageVersion)" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
     <PackageReference Include="NUnit" Version="4.1.0" />
     <PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\..\src\Microsoft.Maui.BindingExtensions.Build.Tasks\Microsoft.Maui.BindingExtensions.Build.Tasks.csproj" />
+    <ProjectReference Include="..\CommunityToolkit.Maui.BindingExtensions\CommunityToolkit.Maui.BindingExtensions.csproj" />
   </ItemGroup>
 
 </Project>
diff --git a/...Extensions.Build.Tests/MockBuildEngine.cs → ...indingExtensions.Tests/MockBuildEngine.cs b/...Extensions.Build.Tests/MockBuildEngine.cs → ...indingExtensions.Tests/MockBuildEngine.cs
@@ -2,7 +2,7 @@
 using Microsoft.Build.Framework;
 using NUnit.Framework;
 
-namespace Microsoft.Maui.BindingExtensions.Build.Tests
+namespace CommunityToolkit.Maui.BindingExtensions.Tests
 {
     public class MockBuildEngine : IBuildEngine4
     {

diff --git a/...ft.Maui.BindingExtensions.Build.Tasks.sln → ...mmunityToolkit.Maui.BindingExtensions.sln b/...ft.Maui.BindingExtensions.Build.Tasks.sln → ...mmunityToolkit.Maui.BindingExtensions.sln
@@ -3,9 +3,9 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.11.34809.278
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Maui.BindingExtensions.Build.Tasks", "src\Microsoft.Maui.BindingExtensions.Build.Tasks\Microsoft.Maui.BindingExtensions.Build.Tasks.csproj", "{D1497B0B-A62D-49AD-833B-EFE4F87B1BEE}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CommunityToolkit.Maui.BindingExtensions", "CommunityToolkit.Maui.BindingExtensions\CommunityToolkit.Maui.BindingExtensions.csproj", "{D1497B0B-A62D-49AD-833B-EFE4F87B1BEE}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Maui.BindingExtensions.Build.Tests", "test\Microsoft.Maui.BindingExtensions.Build.Tests\Microsoft.Maui.BindingExtensions.Build.Tests.csproj", "{7BF30708-BC47-4379-8DC0-E7093AC2FED6}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CommunityToolkit.Maui.BindingExtensions.Tests", "CommunityToolkit.Maui.BindingExtensions.Tests\CommunityToolkit.Maui.BindingExtensions.Tests.csproj", "{7BF30708-BC47-4379-8DC0-E7093AC2FED6}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
-Original file line number
+Diff line change
@@ Expand Up / @@ -403,7 +403,7 @@ FodyWeavers.xsd @@
     xcuserdata/
-    build/
+    **/native/build/
     .build/
     *.xcframework
     Pods/
@@ Expand Down @@