V9.0.3/package maintenance #11
Conversation
WalkthroughThis update revises package dependencies to newer patch versions, updates release notes and changelog entries for version 9.0.3, refreshes Docker and test environment images, and refactors the GitHub Actions workflow to use reusable workflow calls and update test matrix OS versions. Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant GitHub Actions
participant Reusable Workflows
participant DockerHub
Developer->>GitHub Actions: Push code/update workflow
GitHub Actions->>Reusable Workflows: Call build, pack, test, deploy jobs
Reusable Workflows-->>GitHub Actions: Execute job steps (build, pack, test, deploy)
GitHub Actions->>DockerHub: Pull updated Docker images (nginx, docfx, test runner)
GitHub Actions-->>Developer: Report workflow status
Possibly related PRs
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
.docfx/Dockerfile.docfx (1)
11-11: Consider aliasing the base stage
Directly referencingnginx:1.27.5-alpineis fine, but you could strengthen consistency by aliasing the base stage and usingCOPY --from=basefor the final stage.CHANGELOG.md (1)
10-12: Changelog entry formatting
The new## [9.0.3] - 2025-05-25entry is added, but according to Keep a Changelog guidelines, consider adding a link reference at the bottom:[9.0.3]: https://github.com/<yourorg>/<yourrepo>/compare/v9.0.2...v9.0.3to maintain consistency and enable compare views.
.github/workflows/pipelines.yml (2)
26-36: Suggest pinning reusable workflow version
Consider targeting a specific commit SHA rather than@v1to lock the interface and prevent unexpected breakages when the external workflow updates.
39-48: Suggest pinning reusable workflow version
As above, pin the workflow reference to a commit SHA instead of a moving tag to ensure pipeline stability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
.docfx/Dockerfile.docfx(1 hunks).github/workflows/pipelines.yml(2 hunks).nuget/Codebelt.Extensions.AspNetCore.Mvc.Formatters.Newtonsoft.Json/PackageReleaseNotes.txt(1 hunks).nuget/Codebelt.Extensions.AspNetCore.Newtonsoft.Json/PackageReleaseNotes.txt(1 hunks).nuget/Codebelt.Extensions.Newtonsoft.Json.App/PackageReleaseNotes.txt(1 hunks).nuget/Codebelt.Extensions.Newtonsoft.Json/PackageReleaseNotes.txt(1 hunks)CHANGELOG.md(1 hunks)Directory.Packages.props(1 hunks)testenvironments.json(1 hunks)
🧰 Additional context used
🪛 Hadolint (2.12.0)
.docfx/Dockerfile.docfx
[error] 6-6: Use COPY instead of ADD for files and folders
(DL3020)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: call-codeql / 🛡️ Security Analysis
- GitHub Check: call-sonarcloud / 🔬 Code Quality Analysis
🔇 Additional comments (18)
.docfx/Dockerfile.docfx (2)
1-1: Enable multi-platform builds
Good inclusion of--platform=$BUILDPLATFORMflags to support multi-arch. This ensures that images are built for the correct architecture.
4-4: Confirm updated DocFX image
Updating tocodebeltnet/docfx:2.78.3aligns with the latest DocFX improvements. Please verify that the site builds successfully with this image.Directory.Packages.props (3)
6-16: Bulk package version bumps
The core libraries (Codebelt.Extensions.Xunit,Cuemon.*,Microsoft.NET.Test.Sdk) were all incremented. Ensure that none introduce breaking changes in CI and downstream consumers by running a full test suite and verifying transitive dependencies.
24-24: xunit Visual Studio runner update
Bumpingxunit.runner.visualstudioto 3.1.0 should align with the test SDK. Verify that the CI environment supports this version and update any test adapters if necessary.
27-31: TFM-specific NewtonsoftJson alignment
TheMicrosoft.AspNetCore.Mvc.NewtonsoftJsonversions fornet9(9.0.5) andnet8(8.0.16) are updated. Confirm these align with the published NuGet packages and that the conditional groups trigger correctly in each target framework.testenvironments.json (1)
12-12: Verify Docker test image tag
Updating togimlichael/ubuntu-testrunner:net8.0.409-9.0.300should reflect the latest .NET and Ubuntu test runner. Please ensure this image exists and pulls successfully in CI..nuget/Codebelt.Extensions.Newtonsoft.Json.App/PackageReleaseNotes.txt (1)
1-6: Release notes addition looks good
The new version9.0.3entry follows the existing format and correctly highlights dependency upgrades. No issues found..nuget/Codebelt.Extensions.AspNetCore.Mvc.Formatters.Newtonsoft.Json/PackageReleaseNotes.txt (2)
1-2: Add Version 9.0.3 header and availability
The new entry correctly lists version 9.0.3 and availability for .NET 9 and .NET 8, matching the project's supported TFMs.
4-5: Update ALM section for dependency upgrades
The ALM section clearly documents that dependencies have been upgraded to the latest compatible versions for all supported TFMs..nuget/Codebelt.Extensions.Newtonsoft.Json/PackageReleaseNotes.txt (2)
1-2: Add Version 9.0.3 header with full TFM availability
Listing .NET 9, .NET 8, and .NET Standard 2.0 is correct and consistent with the other release notes.
4-5: Document dependency upgrades in ALM section
The change log now accurately notes that dependencies have been upgraded across all supported TFMs..nuget/Codebelt.Extensions.AspNetCore.Newtonsoft.Json/PackageReleaseNotes.txt (2)
1-2: Add Version 9.0.3 header and availability
Correctly reflects .NET 9 and .NET 8 support for this package, matching the project's TFM matrix.
4-5: Mark dependency upgrades in ALM section
The ALM entry succinctly captures that all package dependencies have been bumped to their latest compatible versions..github/workflows/pipelines.yml (5)
26-36: Migrate build job to reusable workflow
The build job now callscodebeltnet/jobs-dotnet-build, consolidating build logic and reducing duplication across pipelines.
39-48: Migrate pack job to reusable workflow
Switching tocodebeltnet/jobs-dotnet-packstreamlines packaging and artifact handling, improving maintainability.
51-62: Adopt reusable test workflow and update OS matrix
The test job now invokescodebeltnet/jobs-dotnet-testand upgrades Ubuntu to 24.04 while retaining Windows 2022 support.
51-62: Verify compatibility of test inputs
Please confirm that thejobs-dotnet-testworkflow supports thebuild-switchesfield and correctly applies theruns-onmatrix values for all intended OS/framework combinations.
93-94: Switch deploy job to NuGet push workflow
Usingcodebeltnet/jobs-nuget-pushaligns the deploy step with the new reusable workflow pattern and simplifies maintainability.
This pull request introduces several updates, including dependency upgrades, workflow simplifications, and Dockerfile improvements. The changes focus on modernizing the codebase, improving maintainability, and ensuring compatibility with the latest frameworks and tools.
Workflow Simplification:
.github/workflows/pipelines.ymlby replacing custom build, pack, and test steps with reusable workflows (codebeltnet/jobs-dotnet-build,codebeltnet/jobs-dotnet-pack,codebeltnet/jobs-dotnet-test) to simplify maintenance. Updated thecall-nugetjob to usejobs-nuget-pushinstead ofjobs-nuget. [1] [2]Dependency and Version Updates:
Directory.Packages.props, includingCuemonandxunitpackages, to their latest versions for improved compatibility and features.Codebelt.Extensions.AspNetCore.Mvc.Formatters.Newtonsoft.Json,Codebelt.Extensions.AspNetCore.Newtonsoft.Json, etc.) to reflect the new version9.0.3and dependency changes. [1] [2] [3] [4]9.0.3inCHANGELOG.md, highlighting the focus on package dependency updates.Dockerfile Improvements:
.docfx/Dockerfile.docfxto use platform-specific builds and upgradednginxanddocfxto newer versions (nginx:1.27.5-alpineandcodebeltnet/docfx:2.78.3).Test Environment Update:
testenvironments.jsontogimlichael/ubuntu-testrunner:net8.0.409-9.0.300for compatibility with the latest .NET versions.Summary by CodeRabbit