V10.1.1/service update #136

gimlichael · 2025-12-12T01:27:01Z

This pull request updates the release notes for multiple NuGet packages across the solution to document the upgrade of dependencies to their latest compatible versions for all supported target frameworks. No code changes are included—only documentation updates for the new version (10.1.1) of each package.

Summary by CodeRabbit

New Features
- Added Version 10.1.1 release with support for .NET 10 and .NET 9.
- Introduced new benchmark runner tooling for performance analysis.
Dependencies
- Upgraded all package dependencies to latest compatible versions.
- Added Codebelt.Extensions.BenchmarkDotNet.Console package.
Build & Infrastructure
- Modernized solution file structure.
- Updated test environment configurations.
Documentation
- Updated package release notes across all packages.
- Refreshed changelog and README references.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2025-12-12T01:27:12Z

Walkthrough

Version 10.1.1 release update adding release notes across all NuGet packages, upgrading package dependencies to latest compatible versions, migrating from .sln to .slnx solution format, and adjusting build configuration properties.

Changes

Cohort / File(s)	Summary
Package Release Notes `.nuget/Cuemon/PackageReleaseNotes.txt`, `.nuget/Cuemon./PackageReleaseNotes.txt`	Added Version 10.1.1 release entries (34 files) with availability details and ALM notes indicating dependencies upgraded to latest compatible versions for all supported target frameworks
Build Configuration `Directory.Build.props`, `Directory.Build.targets`	Moved `PackageReleaseNotesFile` property from targets to props; property now points to `..\..\.nuget\$(MSBuildProjectName)\PackageReleaseNotes.txt`
Dependency Management `Directory.Packages.props`	Added `Codebelt.Extensions.BenchmarkDotNet.Console` v1.0.0; upgraded Microsoft.Data.Sqlite, Microsoft.Bcl.AsyncInterfaces, Microsoft.Extensions.Configuration-related packages to 10.0.1 (netstandard2); bumped Microsoft.Extensions.\* packages to 9.0.11 (net9) and 10.0.1 (net10/netstandard2)
Solution Files `Cuemon.sln`, `Cuemon.slnx`	Removed legacy Cuemon.sln; added new Cuemon.slnx with hierarchical project structure organizing src, test, tooling, and tuning folders
Documentation `README.md`, `CHANGELOG.md`	Updated License and Build Status badge URLs in README; added [10.1.1] release section in CHANGELOG dated 2025-12-12
Benchmark Reports `reports/tuning/Cuemon.*Benchmark-report-github.md` (9 files)	Updated BenchmarkDotNet environment metadata, simplified table column layouts, and reformatted results across all benchmarks reflecting new SDK/runtime versions
Test Environment `testenvironments.json`	Updated Docker image tag from `net8.0.416-9.0.307-10.0.100` to `net8.0.416-9.0.307-10.0.101`
Tooling `tooling/bdn-runner/Program.cs`, `tooling/bdn-runner/bdn-runner.csproj`	Added new benchmark runner project with Program entry point delegating to BenchmarkProgram.Run, targeting net10.0 with project references to tuning projects

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Package Release Notes files: 34+ files with highly repetitive changes (same pattern applied uniformly) significantly reduces per-file review effort
Build property migration: Verify PackageReleaseNotesFile property correctly moved from targets to props and that path resolution works as expected
Dependency updates: Confirm version bumps across multiple target frameworks (net4, net9, net10, netstandard2) are intentional and consistent
Solution file migration: Validate Cuemon.slnx properly references all projects and maintains correct folder hierarchy
Benchmark reports: Multiple reformatted tables with updated environment metadata—verify data integrity and version alignment
New tooling project: Review bdn-runner configuration, job registration, and integration with BenchmarkProgram

Possibly related PRs

V9.0.10/service pack #127: Performs identical repo-wide release/packaging updates (adding new top-version release notes and bumping package versions)
V9.0.2/package maintenance #112: Adds new top release-note entries across many PackageReleaseNotes.txt files and updates package versions in Directory.Packages.props
⬆️ bump dependencies #122: Modifies Directory.Packages.props to update dependency versions across target frameworks

Poem

🐰 A hop and a skip, version ten-point-one-one takes flight,
Dependencies gleaming, all upgraded to their best height,
From .sln we bid goodbye, .slnx shows the way,
Benchmark rabbits dash swiftly through tuning's grand display! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'V10.1.1/service update' is clear and directly related to the main objective of the pull request: releasing version 10.1.1 as a service update focused on dependency upgrades.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch v10.1.1/service-update

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 14

🧹 Nitpick comments (14)

.nuget/Cuemon.Extensions.Data.Integrity/PackageReleaseNotes.txt (1)

1-6: Good additive 10.1.1 entry; consider trimming duplication + normalize whitespace-only lines.

The 10.1.1 block matches the established format and keeps 10.1.0 intact (nice). Two small nits:

The ALM bullet is identical to 10.1.0; if possible, call out what changed (or reference the central dependency update location) to make 10.1.1 meaningful.

Lines 3 and 6 look like non-standard whitespace-only lines (NBSP). Consider normalizing to plain blank lines to avoid future diff churn.

.nuget/Cuemon.Extensions.Threading/PackageReleaseNotes.txt (1)

3-6: Replace NBSP-only “blank” lines with truly empty lines. The lines tend to create noisy diffs and inconsistent rendering in editors/pack tooling.

.nuget/Cuemon.Extensions.AspNetCore.Authentication/PackageReleaseNotes.txt (1)

1-6: New 10.1.1 entry looks consistent with existing format.

Only nit: the “blank” lines (Line 3 and Line 6) appear to be non-breaking spaces; consider normalizing to plain empty lines to avoid tooling/diff churn.

.nuget/Cuemon.Resilience/PackageReleaseNotes.txt (1)

1-6: 10.1.1 entry addition is straightforward and matches the established pattern.

Same optional whitespace note: if those are NBSP “blank” lines, normalize to empty lines.

.nuget/Cuemon.Diagnostics/PackageReleaseNotes.txt (1)

1-6: Release note addition is consistent and non-invasive.

Optional: normalize “blank” lines (possible NBSP) for cleaner diffs/packaging file parsing.

.nuget/Cuemon.IO/PackageReleaseNotes.txt (1)

1-6: 10.1.1 entry is consistent with the file’s existing TFM conventions.

Optional: same NBSP/whitespace normalization suggestion for the “blank” lines.

.nuget/Cuemon.Data.SqlClient/PackageReleaseNotes.txt (1)

1-6: Release notes entry looks consistent with prior versions.
Minor: consider replacing any NBSP-only “blank” lines (Line 3/6) with normal empty lines to reduce diff churn across editors.

.nuget/Cuemon.AspNetCore/PackageReleaseNotes.txt (1)

1-6: Release notes entry looks good and matches the established format.
Same minor note: avoid NBSP-only blank lines (Line 3/6) if possible.
tooling/bdn-runner/bdn-runner.csproj (1)
4-5: Use TargetFramework (singular) if this project will never be multi-targeted.
Not required, but it avoids implying multi-target intent.
-    <TargetFrameworks>net10.0</TargetFrameworks>
+    <TargetFramework>net10.0</TargetFramework>
.nuget/Cuemon.Core/PackageReleaseNotes.txt (1)

1-6: Release notes entry looks good and consistent.
Optional: normalize NBSP-only blank lines (Line 3/6) to true empty lines.

.nuget/Cuemon.AspNetCore.Mvc/PackageReleaseNotes.txt (1)

1-6: Release notes entry looks good and consistent.
Optional: normalize NBSP-only blank lines (Line 3/6) to true empty lines.

.nuget/Cuemon.Extensions.Runtime.Caching/PackageReleaseNotes.txt (1)

1-6: Consider adding a short “notable dependency upgrades” list (current entry is identical to 10.1.0).
If this release is primarily dependency bumps, listing 2–5 key packages (or linking to a central dependency diff) would make the 10.1.1 block more informative than repeating the 10.1.0 wording.

CHANGELOG.md (1)

9-12: Consider adding “### Changed” bullets for 10.1.1 for consistency with the rest of the changelog.
E.g., one bullet for “Dependencies upgraded across supported TFMs” and one for “BenchmarkDotNet tooling integration”, so the entry is easier to scan.
tooling/bdn-runner/Program.cs (1)
1-22: Add XML docs + verify Codebelt/BenchmarkDotNet API compatibility for the selected versions.

Repo guideline: Program / Main are public → add XML doc comments.

Please double-check BenchmarkWorkspaceOptions.Slim, CoreRuntime.Core90, and CoreRuntime.Core10_0 are the intended/available runtime identifiers for the versions referenced by the solution.
 public class Program
 {
+    /// <summary>
+    /// Entry point for running BenchmarkDotNet benchmarks using Codebelt's console runner.
+    /// </summary>
+    /// <param name="args">Command-line arguments forwarded to the benchmark runner.</param>
     public static void Main(string[] args)
     {
         BenchmarkProgram.Run(args, o =>
         {
             o.AllowDebugBuild = BenchmarkProgram.IsDebugBuild;
             o.ConfigureBenchmarkDotNet(c =>
             {
                 var slimJob = BenchmarkWorkspaceOptions.Slim;
                 return c.AddJob(slimJob.WithRuntime(CoreRuntime.Core90))
                     .AddJob(slimJob.WithRuntime(CoreRuntime.Core10_0));
             });
         });
     }
 }

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 61b5ed7 and 3bf5212.

📒 Files selected for processing (60)

.nuget/Cuemon.AspNetCore.App/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.AspNetCore.Authentication/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.AspNetCore.Mvc/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.AspNetCore.Razor.TagHelpers/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.AspNetCore/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Core.App/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Core/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Data.Integrity/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Data.SqlClient/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Data/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Diagnostics/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.AspNetCore.Authentication/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.AspNetCore.Mvc.Formatters.Text.Json/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.AspNetCore.Mvc.Formatters.Xml/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.AspNetCore.Mvc.RazorPages/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.AspNetCore.Mvc/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.AspNetCore.Text.Json/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.AspNetCore.Xml/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.AspNetCore/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.Collections.Generic/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.Collections.Specialized/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.Core/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.Data.Integrity/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.Data/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.DependencyInjection/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.Diagnostics/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.Hosting/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.IO/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.Net/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.Reflection/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.Runtime.Caching/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.Text.Json/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.Text/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.Threading/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Extensions.Xml/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.IO/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Net/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Resilience/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Runtime.Caching/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Security.Cryptography/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Threading/PackageReleaseNotes.txt (1 hunks)
.nuget/Cuemon.Xml/PackageReleaseNotes.txt (1 hunks)
CHANGELOG.md (1 hunks)
Cuemon.sln (0 hunks)
Cuemon.slnx (1 hunks)
Directory.Build.props (1 hunks)
Directory.Build.targets (0 hunks)
Directory.Packages.props (2 hunks)
README.md (1 hunks)
reports/tuning/Cuemon.DateSpanBenchmark-report-github.md (1 hunks)
reports/tuning/Cuemon.DelimitedStringBenchmark-report-github.md (1 hunks)
reports/tuning/Cuemon.GenerateBenchmark-report-github.md (1 hunks)
reports/tuning/Cuemon.Security.Cryptography.AesCryptorBenchmarks-report-github.md (1 hunks)
reports/tuning/Cuemon.Security.Cryptography.Sha512256Benchmark-report-github.md (1 hunks)
reports/tuning/Cuemon.Security.CyclicRedundancyCheckBenchmark-report-github.md (1 hunks)
reports/tuning/Cuemon.Security.FowlerNollVoHashBenchmark-report-github.md (1 hunks)
reports/tuning/Cuemon.Security.HashResultBenchmark-report-github.md (1 hunks)
testenvironments.json (1 hunks)
tooling/bdn-runner/Program.cs (1 hunks)
tooling/bdn-runner/bdn-runner.csproj (1 hunks)

💤 Files with no reviewable changes (2)

Cuemon.sln
Directory.Build.targets

🧰 Additional context used

📓 Path-based instructions (1)

**/*.cs

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Add XML doc comments to public and protected classes and methods where appropriate in C# files

Files:

tooling/bdn-runner/Program.cs

🧠 Learnings (18)