V9.0.3/package maintenance #12
Conversation
WalkthroughThis update upgrades several package dependencies, Docker images, and test environment configurations. It refactors the GitHub Actions pipeline to use reusable workflow calls instead of inline job steps. Changelog and release notes are updated to reflect the new version and dependency changes. No public code entities are modified. Changes
Sequence Diagram(s)sequenceDiagram
participant GitHub Actions
participant Reusable Workflow (Build/Pack/Test/Deploy)
GitHub Actions->>Reusable Workflow (Build): Call jobs-dotnet-build with inputs/secrets
GitHub Actions->>Reusable Workflow (Pack): Call jobs-dotnet-pack with inputs
GitHub Actions->>Reusable Workflow (Test): Call jobs-dotnet-test with inputs
GitHub Actions->>Reusable Workflow (Deploy): Call jobs-nuget-push with inputs
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 (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #12 +/- ##
=======================================
Coverage 89.69% 89.69%
=======================================
Files 4 4
Lines 97 97
Branches 9 9
=======================================
Hits 87 87
Misses 10 10 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
.docfx/Dockerfile.docfx(1 hunks).github/workflows/pipelines.yml(2 hunks).nuget/Codebelt.Extensions.Asp.Versioning/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 (10)
Directory.Packages.props (2)
10-17: Approve dependency version bumps
The updated minor/patch versions for Codebelt and Cuemon packages, as well as the .NET Test SDK, align with the release notes and maintain backward compatibility.
23-23: Review xUnit runner major version bump
Thexunit.runner.visualstudiopackage was updated from 3.0.2 → 3.1.0—a major version change. Please verify compatibility with the existingxunitcore (2.9.3) and ensure CI test jobs still execute without errors.CHANGELOG.md (1)
10-13: Changelog entry follows convention
The new9.0.3entry and description are consistent with prior releases and the “Keep a Changelog” format. No further edits needed.testenvironments.json (1)
12-12: Approve test environment image update
The Docker image forDocker-Ubuntuhas been bumped tonet8.0.409-9.0.300, matching the updated SDK and package versions..nuget/Codebelt.Extensions.Asp.Versioning/PackageReleaseNotes.txt (1)
1-5: Approve package release notes update
The newVersion 9.0.3section clearly states .NET 8/9 support and dependency upgrades, in line withDirectory.Packages.props..docfx/Dockerfile.docfx (1)
1-4: Upgrade Docker base images and enable multi-platform builds
Switched to--platform=$BUILDPLATFORMand bumped tonginx:1.27.5-alpine/codebeltnet/docfx:2.78.3. Ensure you test the DocFX generation and final NGINX container on all target architectures in your CI matrix.Also applies to: 11-11
.github/workflows/pipelines.yml (4)
26-36: Streamline the build job using a reusable workflowThe
buildjob now delegates tocodebeltnet/jobs-dotnet-buildwith a matrix of configurations and securely passes the required GCP secrets. This removes inline steps and centralizes build logic per PR objectives.
39-48: Refactor the pack job into a reusable workflowThe
packjob correctly callscodebeltnet/jobs-dotnet-packwith inputs for configuration, version, and artifact uploading. This aligns with the goal of reducing duplication and standardizing packaging across repositories.
51-62: Leverage the reusable test workflowThe
testjob is streamlined viacodebeltnet/jobs-dotnet-test, preserving the OS/configuration matrix and passingbuild-switchesas required. Keepingfail-fast: falseensures all matrix permutations run. Great consistency.
92-93: Update deploy job to use the nuget-push workflowThe
deployjob now invokescodebeltnet/jobs-nuget-pushand correctly lists itsneedsdependencies. This change matches naming conventions and centralizes NuGet publishing logic.
| RUN rm -rf /usr/share/nginx/html/* | ||
|
|
||
| FROM codebeltnet/docfx:2.77.0 AS build | ||
| FROM --platform=$BUILDPLATFORM codebeltnet/docfx:2.78.3 AS build | ||
|
|
||
| ADD [".", "docfx"] |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Replace ADD with COPY for directory assets
ADD is reserved for remote URLs or archives; use COPY to bring in the local docfx folder instead.
- ADD [".", "docfx"]
+ COPY [".", "docfx"]📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ADD [".", "docfx"] | |
| COPY [".", "docfx"] |
🧰 Tools
🪛 Hadolint (2.12.0)
[error] 6-6: Use COPY instead of ADD for files and folders
(DL3020)
🤖 Prompt for AI Agents
In .docfx/Dockerfile.docfx at line 6, replace the ADD instruction with COPY to
copy the local docfx directory. Change the line from ADD [".", "docfx"] to COPY
[".", "docfx"] because ADD is intended for remote URLs or archives, while COPY
is the correct command for copying local directory assets.
|
This pull request includes updates to dependencies, Docker configurations, workflows, and release notes. The changes aim to improve compatibility, streamline CI/CD processes, and document updates. Below is a summary of the most important changes:
Dependency Updates
Directory.Packages.props, includingCodebelt.Extensions.AspNetCore.Mvc.Formatters.Newtonsoft.Json(9.0.3),Cuemon.AspNetCore(9.0.5), andxunit.runner.visualstudio(3.1.0), to ensure compatibility with the latest frameworks and tools.Docker Configuration
.docfx/Dockerfile.docfxto usenginx:1.27.5-alpineandcodebeltnet/docfx:2.78.3for improved security and compatibility.CI/CD Workflow Simplification
.github/workflows/pipelines.ymlby replacing inline job definitions with reusable workflows forbuild,pack, andteststages. This reduces redundancy and centralizes workflow logic.call-nugetjob to use thecodebeltnet/jobs-nuget-pushreusable workflow for better alignment with the naming convention.Documentation Updates
CHANGELOG.mdand updatedPackageReleaseNotes.txtto reflect dependency upgrades and availability for .NET 8 and 9. [1] [2]Test Environment
testenvironments.jsontogimlichael/ubuntu-testrunner:net8.0.409-9.0.300for testing with the latest runtime versions.Summary by CodeRabbit
Chores
Documentation