Skip to content

Conversation

@gimlichael
Copy link
Member

@gimlichael gimlichael commented Jan 23, 2026

This pull request contains a service update focused on improving documentation, updating package dependencies, and clarifying conventions for unit and performance tests. The most significant changes include the introduction of a detailed prompt for generating performance benchmarks, updates to documentation to use generic project names and discourage the use of InternalsVisibleTo, and dependency upgrades for all packages. Below are the most important changes grouped by theme:

Documentation and Conventions:

  • Overhauled .github/copilot-instructions.md to generalize instructions for unit tests, performance tests, and XML documentation. References to "Bootstrapper" were replaced with "YourProject" or "Cuemon" to make the documentation reusable for other projects, and new guidelines were added discouraging the use of InternalsVisibleTo in tests. [1] [2] [3] [4] [5] [6] [7] [8]
  • Added a new benchmark prompt .github/prompts/benchmark.prompt.md that defines strict conventions and best practices for generating BenchmarkDotNet performance tests, including naming, placement, structure, and attribute usage.

Dependency and Version Updates:

  • Updated package release notes for all main packages (Codebelt.Bootstrapper, Codebelt.Bootstrapper.Console, Codebelt.Bootstrapper.Web, Codebelt.Bootstrapper.Worker) to version 5.0.3, noting that dependencies have been upgraded to the latest compatible versions for all supported target frameworks. [1] [2] [3] [4]
  • Updated the NGINX version in .docfx/Dockerfile.docfx from 1.29.3-alpine to 1.29.4-alpine.

Changelog and Metadata:

  • Added a new changelog entry for version 5.0.3 in CHANGELOG.md, describing it as a service update focused on package dependencies.
  • Updated the copyright year in .docfx/docfx.json from 2025 to 2026.

These changes improve maintainability, ensure documentation is project-agnostic, and keep dependencies up to date.

Summary by CodeRabbit

Release Notes

  • Chores

    • Updated dependencies to latest compatible versions
    • Added .NET 10 and .NET 9 support for package releases
    • Updated copyright year to 2026
    • Restructured solution configuration
  • Documentation

    • Added version 5.0.3 release notes documenting dependency upgrades and expanded framework support

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

@gimlichael gimlichael self-assigned this Jan 23, 2026
Copilot AI review requested due to automatic review settings January 23, 2026 18:03
@coderabbitai
Copy link

coderabbitai bot commented Jan 23, 2026

📝 Walkthrough

Walkthrough

This pull request performs a v5.0.3 service update, bumping package dependencies across the project, migrating solution format from .sln to .slnx, updating copyright years to 2026, generalizing documentation from Bootstrapper-specific to generic project examples, and adding benchmark guidelines.

Changes

Cohort / File(s) Summary
Version & Release Updates
.nuget/Codebelt.Bootstrapper.Console/PackageReleaseNotes.txt, .nuget/Codebelt.Bootstrapper.Web/PackageReleaseNotes.txt, .nuget/Codebelt.Bootstrapper.Worker/PackageReleaseNotes.txt, .nuget/Codebelt.Bootstrapper/PackageReleaseNotes.txt, CHANGELOG.md
Added new v5.0.3 release entries with .NET 10 and .NET 9 availability and dependency upgrade notes.
Copyright Year Updates
.docfx/docfx.json, Directory.Build.props, LICENSE.md
Updated copyright year ranges from 2024-2025/2021-2025 to 2024-2026/2021-2026 respectively.
Build Configuration
Directory.Build.props, Directory.Build.targets
Relocated PackageReleaseNotesFile property from Directory.Build.targets to Directory.Build.props and added property definition.
Solution & Project Structure
Codebelt.Bootstrapper.sln, Codebelt.Bootstrapper.slnx
Removed legacy .sln file and introduced new .slnx format solution file with updated folder structure (/app/, /src/, /test/).
Dependencies
Directory.Packages.props, testenvironments.json
Bumped 17 central NuGet package versions (Cuemon.\, Codebelt.\, xunit.v3.\, Microsoft.AspNetCore.\, Microsoft.Extensions.\*) and updated Docker test image tag.
Documentation & Guidelines
.github/copilot-instructions.md, .github/prompts/benchmark.prompt.md
Generalized Bootstrapper-specific documentation to generic YourProject examples; added comprehensive BenchmarkDotNet prompt.
Docker Infrastructure
.docfx/Dockerfile.docfx
Bumped NGINX version from 1.29.3-alpine to 1.29.4-alpine.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • V4.0.4/service update #16 — Both PRs perform service updates bumping central package versions, updating testenvironments.json, and adding release notes/CHANGELOG entries.
  • V4.0.5/service update #17 — Both PRs modify the same ARG NGINX_VERSION in .docfx/Dockerfile.docfx, each bumping the nginx version incrementally.
  • V4.0.1/package maintenance #13 — Both PRs modify overlapping configuration files (.docfx/Dockerfile.docfx, Directory.Packages.props, testenvironments.json, and release notes) indicating shared maintenance patterns.

Poem

🐰 A service hop, dependencies soar,
Copyright refreshed, now twenty-twenty-six more,
Old .sln transformed to slnx so new,
Nginx upgraded, and benchmarks too,
With generic docs, the project's renewed!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'V5.0.3/service update' directly corresponds to the main change—a version 5.0.3 service update focusing on package dependencies, release notes, and documentation improvements as outlined in the PR objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Service update for v5.0.3 focused on dependency bumps, packaging/build metadata tweaks, and refreshed Copilot guidance (including benchmark-generation conventions).

Changes:

  • Updated centralized NuGet package versions and test runner environment image.
  • Moved PackageReleaseNotesFile property configuration from Directory.Build.targets to Directory.Build.props and updated release metadata (copyright/changelog).
  • Added/updated GitHub Copilot documentation and introduced a dedicated BenchmarkDotNet prompt.

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
testenvironments.json Updates Docker test runner image tag used by test environments.
LICENSE.md Bumps copyright year to 2026.
Directory.Packages.props Upgrades centrally-managed package versions (Cuemon, xUnit, MinVer, ASP.NET packages).
Directory.Build.targets Removes PackageReleaseNotesFile property definition from targets.
Directory.Build.props Defines PackageReleaseNotesFile earlier in build props; updates copyright metadata.
Codebelt.Bootstrapper.slnx Adds new XML-based solution representation listing projects by folder.
Codebelt.Bootstrapper.sln Removes legacy .sln solution file.
CHANGELOG.md Adds 5.0.3 entry dated 2026-01-23.
.nuget/Codebelt.Bootstrapper/PackageReleaseNotes.txt Adds 5.0.3 release notes entry.
.nuget/Codebelt.Bootstrapper.Console/PackageReleaseNotes.txt Adds 5.0.3 release notes entry.
.nuget/Codebelt.Bootstrapper.Web/PackageReleaseNotes.txt Adds 5.0.3 release notes entry.
.nuget/Codebelt.Bootstrapper.Worker/PackageReleaseNotes.txt Adds 5.0.3 release notes entry.
.github/prompts/benchmark.prompt.md Introduces a strict prompt for generating BenchmarkDotNet benchmark fixtures.
.github/copilot-instructions.md Generalizes and expands Copilot guidance for tests/benchmarks/docs; adds guidance discouraging InternalsVisibleTo.
.docfx/docfx.json Updates DocFX footer copyright range to 2026.
.docfx/Dockerfile.docfx Bumps NGINX version used for DocFX container.

@codecov
Copy link

codecov bot commented Jan 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 83.84%. Comparing base (2055d73) to head (f757084).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #22   +/-   ##
=======================================
  Coverage   83.84%   83.84%           
=======================================
  Files          20       20           
  Lines         260      260           
  Branches       19       19           
=======================================
  Hits          218      218           
  Misses         42       42           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@sonarqubecloud
Copy link

@gimlichael gimlichael merged commit 1576987 into main Jan 23, 2026
27 checks passed
@gimlichael gimlichael deleted the v5.0.3/service-update branch January 23, 2026 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants