All .NET 6+ libraries now generate xml doc files to get picked up by …

…nuget.
vchelaru · Apr 25, 2024 · 855f193 · 855f193
1 parent 61778b4
commit 855f193
Show file tree

Hide file tree

Showing 13 changed files with 49 additions and 25 deletions.
diff --git a/.github/workflows/Engine.yml b/.github/workflows/Engine.yml
@@ -63,22 +63,22 @@ jobs:
       with:
         name: iOSMonoGameNet8Debug
         path: FlatRedBall\Engines\Forms\FlatRedBall.Forms\FlatRedBall.Forms.iOSMonoGame\bin\Debug\net8.0-ios\
+    - name: Publish NuGet package iOS .NET 8
+      run: |
+        $files = Get-ChildItem -Path 'FlatRedBall\Engines\FlatRedBallXNA\FlatRedBalliOS\bin\Debug\*.nupkg'
+        foreach ($file in $files) {
+          dotnet nuget push $file.FullName --api-key "${{ secrets.NUGET_APIKEY }}" --source https://api.nuget.org/v3/index.json
+        }     
 
 
     - name: Build FlatRedBall iOS .NET 8 Release
       run: dotnet build -c Release 'FlatRedBall\Engines\Forms\FlatRedBall.Forms\FlatRedBall.Forms.iOS.Net8.sln'
+      ## We don't (yet?) publish any release nuget packages, but we do this in preparation for this in the future
     - name: Package FlatRedBall iOS .NET 8
       uses: actions/upload-artifact@v3
       with:
         name: iOSMonoGameNet8Release
         path: FlatRedBall\Engines\Forms\FlatRedBall.Forms\FlatRedBall.Forms.iOSMonoGame\bin\Release\net8.0-ios\
-
-    - name: Publish NuGet package iOS .NET 8
-      run: |
-        $files = Get-ChildItem -Path 'FlatRedBall\Engines\FlatRedBallXNA\FlatRedBalliOS\bin\Debug\*.nupkg'
-        foreach ($file in $files) {
-          dotnet nuget push $file.FullName --api-key "${{ secrets.NUGET_APIKEY }}" --source https://api.nuget.org/v3/index.json
-        }     
 
 
     - name: Build FlatRedBall Android .NET 8 Debug
@@ -88,21 +88,22 @@ jobs:
       with:
         name: AndroidMonoGameNet8Debug
         path: FlatRedBall\Engines\Forms\FlatRedBall.Forms\FlatRedBall.Forms.AndroidMonoGame\bin\Debug\net8.0-android\
+    - name: Publish NuGet package Android .NET 8
+      run: |
+        $files = Get-ChildItem -Path 'FlatRedBall\Engines\FlatRedBallXNA\FlatRedBallAndroid\bin\Debug\*.nupkg'
+        foreach ($file in $files) {
+          dotnet nuget push $file.FullName --api-key "${{ secrets.NUGET_APIKEY }}" --source https://api.nuget.org/v3/index.json
+        }        
 
     - name: Build FlatRedBall Android .NET 8 Release
       run: dotnet build -c Release 'FlatRedBall\Engines\Forms\FlatRedBall.Forms\FlatRedBall.Forms.Android.Net8.sln'
+      ## We don't (yet?) publish any release nuget packages, but we do this in preparation for this in the future
     - name: Package FlatRedBall Android .NET 8
       uses: actions/upload-artifact@v3
       with:
         name: AndroidMonoGameNet8Release
         path: FlatRedBall\Engines\Forms\FlatRedBall.Forms\FlatRedBall.Forms.AndroidMonoGame\bin\Release\net8.0-android\
 
-    - name: Publish NuGet package Android .NET 8
-      run: |
-        $files = Get-ChildItem -Path 'FlatRedBall\Engines\FlatRedBallXNA\FlatRedBallAndroid\bin\Debug\*.nupkg'
-        foreach ($file in $files) {
-          dotnet nuget push $file.FullName --api-key "${{ secrets.NUGET_APIKEY }}" --source https://api.nuget.org/v3/index.json
-        }        
 
 
 
@@ -113,21 +114,22 @@ jobs:
       with:
         name: DesktopGlFnaNet7Debug
         path: FlatRedBall/Engines/Forms/FlatRedBall.Forms/FlatRedBall.Forms.FNA/bin/Debug/net7.0/
+    - name: Publish NuGet package FRB FNA .NET 7
+      run: |
+        $files = Get-ChildItem -Path 'FlatRedBall\Engines\FlatRedBallXNA\FlatRedBall.FNA\bin\Debug\*.nupkg'
+        foreach ($file in $files) {
+          dotnet nuget push $file.FullName --api-key "${{ secrets.NUGET_APIKEY }}" --source https://api.nuget.org/v3/index.json
+        }        
 
     - name: Build FlatRedBall FNA .NET 7 Release
       run: dotnet build -c Release 'FlatRedBall\Engines\Forms\FlatRedBall.Forms\FlatRedBall.Forms.FNA.sln'
+      ## We don't (yet?) publish any release nuget packages, but we do this in preparation for this in the future
     - name: Package FlatRedBall FNA .NET 7
       uses: actions/upload-artifact@v3
       with:
         name: DesktopGlFnaNet7Release
         path: FlatRedBall/Engines/Forms/FlatRedBall.Forms/FlatRedBall.Forms.FNA/bin/Release/net7.0/    
 
-    - name: Publish NuGet package FRB FNA .NET 7
-      run: |
-        $files = Get-ChildItem -Path 'FlatRedBall\Engines\FlatRedBallXNA\FlatRedBall.FNA\bin\Debug\*.nupkg'
-        foreach ($file in $files) {
-          dotnet nuget push $file.FullName --api-key "${{ secrets.NUGET_APIKEY }}" --source https://api.nuget.org/v3/index.json
-        }        
 
     - name: Build FlatRedBall DesktopGL .NET 6 Debug
       run: dotnet build -c Debug 'FlatRedBall\Engines\Forms\FlatRedBall.Forms\FlatRedBall.Forms.DesktopGLNet6.sln'
@@ -136,20 +138,21 @@ jobs:
       with:
         name: DesktopGlNet6Debug
         path: FlatRedBall/Engines/Forms/FlatRedBall.Forms/FlatRedBall.Forms.DesktopGlNet6/bin/Debug/net6.0/
+    - name: Publish NuGet package DesktopGL .NET 6
+      run: |
+        $files = Get-ChildItem -Path 'FlatRedBall\Engines\FlatRedBallXNA\FlatRedBallDesktopGLNet6\bin\Debug\*.nupkg'
+        foreach ($file in $files) {
+          dotnet nuget push $file.FullName --api-key "${{ secrets.NUGET_APIKEY }}" --source https://api.nuget.org/v3/index.json
+        }
 
     - name: Build FlatRedBall DesktopGL .NET 6 Release
       run: dotnet build -c Release 'FlatRedBall\Engines\Forms\FlatRedBall.Forms\FlatRedBall.Forms.DesktopGLNet6.sln'
+      ## We don't (yet?) publish any release nuget packages, but we do this in preparation for this in the future
     - name: Package FlatRedBall .NET 6
       uses: actions/upload-artifact@v3
       with:
         name: DesktopGlNet6Release
         path: FlatRedBall/Engines/Forms/FlatRedBall.Forms/FlatRedBall.Forms.DesktopGlNet6/bin/Release/net6.0/
-    - name: Publish NuGet package DesktopGL .NET 6
-      run: |
-        $files = Get-ChildItem -Path 'FlatRedBall\Engines\FlatRedBallXNA\FlatRedBallDesktopGLNet6\bin\Debug\*.nupkg'
-        foreach ($file in $files) {
-          dotnet nuget push $file.FullName --api-key "${{ secrets.NUGET_APIKEY }}" --source https://api.nuget.org/v3/index.json
-        }
 
     - name: Build FlatRedBall .NET 4 Debug
       if: ${{ github.event.inputs.IsBeta == 'false' }}
@@ -160,10 +163,12 @@ jobs:
       with:
         name: DesktopGlNet4Debug
         path: FlatRedBall/Engines/Forms/FlatRedBall.Forms/FlatRedBall.Forms/bin/DesktopGL/Debug/
+        ## Net4 doesn't (and maybe never will) nuget publish. We still have this as of April 25,2024 for historical reasons but this will get retired in the future
 
     - name: Build FlatRedBall .NET 4 Release
       if: ${{ github.event.inputs.IsBeta == 'false' }}
       run: dotnet build -c Release 'FlatRedBall\Engines\Forms\FlatRedBall.Forms\FlatRedBall.Forms.DesktopGL.sln'
+      ## We don't (yet?) publish any release nuget packages, but we do this in preparation for this in the future
     - name: Package FlatRedBall .NET 4
       if: ${{ github.event.inputs.IsBeta == 'false' }}
       uses: actions/upload-artifact@v3

diff --git a/Engines/FlatRedBallXNA/FlatRedBall.FNA/FlatRedBall.FNA.csproj b/Engines/FlatRedBallXNA/FlatRedBall.FNA/FlatRedBall.FNA.csproj
@@ -5,6 +5,8 @@
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>enable</Nullable>
         <DefineConstants>TRACE; DESKTOP_GL; XNA4; FRB_XNA; FNA;</DefineConstants>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+
 	</PropertyGroup>
     <PropertyGroup>
         <Title>FlatRedBall (.NET FNA)</Title>

diff --git a/Engines/FlatRedBallXNA/FlatRedBallAndroid/FlatRedBallAndroid.csproj b/Engines/FlatRedBallXNA/FlatRedBallAndroid/FlatRedBallAndroid.csproj
@@ -12,6 +12,7 @@
 		<Description>FlatRedBall Game Engine</Description>
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 		<Version>1.0.0</Version>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
 	</PropertyGroup>
 
 	<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">

diff --git a/Engines/FlatRedBallXNA/FlatRedBallDesktopGLNet6/FlatRedBallDesktopGLNet6.csproj b/Engines/FlatRedBallXNA/FlatRedBallDesktopGLNet6/FlatRedBallDesktopGLNet6.csproj
@@ -10,6 +10,8 @@
     <Description>FlatRedBall Game Engine</Description>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <Version>1.0.0</Version>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+
   </PropertyGroup>
   <Import Project="..\FlatRedBall\FlatRedBallShared.projitems" Label="Shared" />
 

diff --git a/Engines/FlatRedBallXNA/FlatRedBalliOS/FlatRedBalliOS.csproj b/Engines/FlatRedBallXNA/FlatRedBalliOS/FlatRedBalliOS.csproj
@@ -11,6 +11,8 @@
     <Description>FlatRedBall Game Engine</Description>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <Version>1.0.0</Version>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
     <DefineConstants>$(DefineConstants);FRB_XNA;IOS;MONOGAME;XNA4;MONOGAME_381;USE_ISOLATED_STORAGE</DefineConstants>

diff --git a/...tRedBall.Forms/FlatRedBall.Forms.AndroidMonoGame/FlatRedBall.Forms.AndroidMonoGame.csproj b/...tRedBall.Forms/FlatRedBall.Forms.AndroidMonoGame/FlatRedBall.Forms.AndroidMonoGame.csproj
@@ -4,6 +4,7 @@
     <TargetFramework>net8.0-android</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
+	  <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/.../FlatRedBall.Forms/FlatRedBall.Forms.DesktopGlNet6/FlatRedBall.Forms.DesktopGlNet6.csproj b/.../FlatRedBall.Forms/FlatRedBall.Forms.DesktopGlNet6/FlatRedBall.Forms.DesktopGlNet6.csproj
@@ -3,6 +3,7 @@
     <TargetFramework>net6.0</TargetFramework>
 	<DefineConstants>MONOGAME;DESKTOP_GL;XNA4;FRB_XNA;WINDOWS;MONOGAME_381</DefineConstants>
 	<GeneratePackageOnBuild>False</GeneratePackageOnBuild>
+	  <GenerateDocumentationFile>true</GenerateDocumentationFile>
 
   </PropertyGroup>
   <ItemGroup>

diff --git a/Engines/Forms/FlatRedBall.Forms/FlatRedBall.Forms.FNA/FlatRedBall.Forms.FNA.csproj b/Engines/Forms/FlatRedBall.Forms/FlatRedBall.Forms.FNA/FlatRedBall.Forms.FNA.csproj
@@ -3,6 +3,7 @@
     <TargetFramework>net7.0</TargetFramework>
 	<DefineConstants>FNA;DESKTOP_GL;XNA4;FRB_XNA;WINDOWS</DefineConstants>
 	<GeneratePackageOnBuild>False</GeneratePackageOnBuild>
+	  <GenerateDocumentationFile>true</GenerateDocumentationFile>
 
   </PropertyGroup>
   <ItemGroup>

diff --git a/...orms/FlatRedBall.Forms/FlatRedBall.Forms.iOSMonoGame/FlatRedBall.Forms.iOSMonoGame.csproj b/...orms/FlatRedBall.Forms/FlatRedBall.Forms.iOSMonoGame/FlatRedBall.Forms.iOSMonoGame.csproj
@@ -4,6 +4,8 @@
     <TargetFramework>net8.0-ios</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
+	  <GenerateDocumentationFile>true</GenerateDocumentationFile>
+
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/...nterpolation/StateInterpolation.AndroidMonoGame/StateInterpolation.AndroidMonoGame.csproj b/...nterpolation/StateInterpolation.AndroidMonoGame/StateInterpolation.AndroidMonoGame.csproj
@@ -4,6 +4,7 @@
     <TargetFramework>net8.0-android</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
+	  <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <Import Project="..\..\..\..\..\FRBDK\Glue\StateInterpolationPlugin\StateInterpolationPlugin\StateInterpolationShared.projitems" Label="Shared" />

diff --git a/...StateInterpolation/StateInterpolation.DesktopGlNet6/StateInterpolation.DesktopNet6.csproj b/...StateInterpolation/StateInterpolation.DesktopGlNet6/StateInterpolation.DesktopNet6.csproj
@@ -1,6 +1,8 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFramework>net6.0</TargetFramework>
+	  <GenerateDocumentationFile>true</GenerateDocumentationFile>
+
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="MonoGame.Framework.DesktopGL" Version="3.8.1.303">

diff --git a/...FlatRedBall.Forms/StateInterpolation/StateInterpolation.FNA/StateInterpolation.FNA.csproj b/...FlatRedBall.Forms/StateInterpolation/StateInterpolation.FNA/StateInterpolation.FNA.csproj
@@ -2,6 +2,8 @@
   <PropertyGroup>
     <TargetFramework>net7.0</TargetFramework>
     <DefineConstants>FNA;XNA4</DefineConstants>
+	  <GenerateDocumentationFile>true</GenerateDocumentationFile>
+
   </PropertyGroup>
   <ItemGroup>
     <ProjectReference Include="..\..\..\..\FlatRedBallXNA\3rd Party Libraries\FNA\FNA.Core.csproj" />

diff --git a/...s/StateInterpolation/StateInterpolation.iOSMonoGame/StateInterpolation.iOSMonoGame.csproj b/...s/StateInterpolation/StateInterpolation.iOSMonoGame/StateInterpolation.iOSMonoGame.csproj
@@ -4,6 +4,8 @@
     <TargetFramework>net8.0-ios</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
+	  <GenerateDocumentationFile>true</GenerateDocumentationFile>
+
   </PropertyGroup>
 
   <ItemGroup>