Extend NuGet package validation

.config/dotnet-tools.json

@@ -8,6 +8,13 @@
         "dotnet-validate"
       ],
       "rollForward": false
+    },
+    "meziantou.framework.nugetpackagevalidation.tool": {
+      "version": "1.0.31",
+      "commands": [
+        "meziantou.validate-nuget-package"
+      ],
+      "rollForward": false
     }
   }
 }

.github/workflows/ci.yml

@@ -27,6 +27,7 @@ jobs:
     outputs:
       dotnet-sdk-version: ${{ steps.setup-dotnet.outputs.dotnet-version }}
       dotnet-validate-version: ${{ steps.get-dotnet-tools-versions.outputs.dotnet-validate-version }}
+      nuget-package-validation-version: ${{ steps.get-dotnet-tools-versions.outputs.nuget-package-validation-version }}
 
     permissions:
       attestations: write
@@ -96,7 +97,9 @@ jobs:
       run: |
         $manifest = (Get-Content "./.config/dotnet-tools.json" | Out-String | ConvertFrom-Json)
         $dotnetValidateVersion = $manifest.tools.'dotnet-validate'.version
+        $nugetPackageValidationVersion = $manifest.tools.'meziantou.framework.nugetpackagevalidation.tool'.version
         "dotnet-validate-version=${dotnetValidateVersion}" >> ${env:GITHUB_OUTPUT}
+        "nuget-package-validation-version=${nugetPackageValidationVersion}" >> ${env:GITHUB_OUTPUT}
 
   validate-packages:
     needs: build-test
@@ -113,17 +116,33 @@ jobs:
       with:
         dotnet-version: ${{ needs.build-test.outputs.dotnet-sdk-version }}
 
-    - name: Validate NuGet packages
+    - name: Install NuGet package validation tools
       shell: pwsh
       env:
         DOTNET_VALIDATE_VERSION: ${{ needs.build-test.outputs.dotnet-validate-version }}
+        NUGET_PACKAGE_VALIDATION_VERSION: ${{ needs.build-test.outputs.nuget-package-validation-version }}
       run: |
         dotnet tool install --global dotnet-validate --version ${env:DOTNET_VALIDATE_VERSION} --allow-roll-forward
+        dotnet tool install --global Meziantou.Framework.NuGetPackageValidation.Tool --version ${env:NUGET_PACKAGE_VALIDATION_VERSION} --allow-roll-forward
+
+    - name: Validate NuGet packages
+      shell: pwsh
+      env:
+        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
         $packages = Get-ChildItem -Filter "*.nupkg" | ForEach-Object { $_.FullName }
         $invalidPackages = 0
         foreach ($package in $packages) {
+          $isValid = $true
           dotnet validate package local $package
           if ($LASTEXITCODE -ne 0) {
+            $isValid = $false
+          }
+          meziantou.validate-nuget-package $package --github-token ${env:GH_TOKEN}
+          if ($LASTEXITCODE -ne 0) {
+            $isValid = $false
+          }
+          if (-Not $isValid) {
             $invalidPackages++
           }
         }

CHANGELOG.md

@@ -44,6 +44,9 @@
 
 ### New features
 
+* Include XML documentation in the `Grafana.OpenTelemetry` and
+  `Grafana.OpenTelemetry.Base` NuGet packages.
+  [#295](https://github.com/grafana/grafana-opentelemetry-dotnet/pull/295)
 * Enable metrics for SQL Client instrumentation
   ([#145](https://github.com/grafana/grafana-opentelemetry-dotnet/pull/145))
 * Use 1.12.0 of OpenTelemetry ([#145](https://github.com/grafana/grafana-opentelemetry-dotnet/pull/145))

src/Grafana.OpenTelemetry.Base/ExporterSettings/ExporterSettings.cs

@@ -45,7 +45,7 @@ public abstract class ExporterSettings
 
         /// <summary>
         /// Applies the exporter settings by initializing an exporter on the
-        /// given <see cref="ILoggingBuilder"/>.
+        /// given <see cref="Microsoft.Extensions.Logging.ILoggingBuilder"/>.
         /// </summary>
         /// <param name="options">A <see cref="OpenTelemetryLoggerOptions"/> instance.</param>
         internal abstract void Apply(OpenTelemetryLoggerOptions options);

src/Grafana.OpenTelemetry.Base/Grafana.OpenTelemetry.Base.csproj

@@ -2,6 +2,7 @@
 
   <PropertyGroup>
     <Description>Minimal Grafana distribution of OpenTelemetry .NET</Description>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <TargetFrameworks>net8.0;netstandard2.0;net462</TargetFrameworks>
   </PropertyGroup>

src/Grafana.OpenTelemetry/Grafana.OpenTelemetry.csproj

@@ -2,6 +2,7 @@
 
   <PropertyGroup>
     <Description>Full Grafana distribution of OpenTelemetry .NET</Description>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <TargetFrameworks>net8.0;netstandard2.0;net462</TargetFrameworks>
   </PropertyGroup>

src/Grafana.OpenTelemetry/OpenTelemetryBuilderExtension.cs

@@ -11,7 +11,7 @@
 namespace Grafana.OpenTelemetry
 {
     /// <summary>
-    /// Extension for the <see cref="OpenTelemetry.OpenTelemetryBuilder"/> provided by the OpenTelemetry .NET distribution 
+    /// Extension for the <see cref="IOpenTelemetryBuilder"/> provided by the OpenTelemetry .NET distribution 
     /// for Grafana.
     ///
     /// This is used for easier configuration for ASP.NET Core projects.