V9.0.5/service update #12
Conversation
WalkthroughThis update introduces a build argument for the nginx version in the DocFX Dockerfile, updates several package dependencies to newer patch versions, advances workflow job versions in the CI pipeline, amends test environment Docker tags, and adds new release notes and changelog entries for version 9.0.5. Changes
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 84.81% 84.81%
=======================================
Files 11 11
Lines 237 237
Branches 9 9
=======================================
Hits 201 201
Misses 36 36 ☔ 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
🧹 Nitpick comments (3)
.docfx/Dockerfile.docfx (1)
1-3: Nice parameterisation, but consider advertising the ARG in each stage
ARGdefined before the firstFROMis global, yet re-declaring it in subsequent stages makes intent clearer and allows stage-local overrides if ever needed:ARG NGINX_VERSION=1.29.0-alpine FROM --platform=$BUILDPLATFORM nginx:${NGINX_VERSION} AS base +ARG NGINX_VERSION # <-- explicit in stagePurely cosmetic, but increases readability.
CHANGELOG.md (1)
10-13: Missing “Changed” bullet list undermines changelog consistencyAll earlier entries list concrete bullet points under “### Dependencies” or similar.
Consider adding the section headers for 9.0.5 to stay consistent with Keep-a-Changelog:## [9.0.5] - 2025-07-11 ### Changed - Dependencies upgraded to latest compatible patch versions..nuget/Codebelt.Extensions.Swashbuckle.AspNetCore/PackageReleaseNotes.txt (1)
1-6: Minor formatting inconsistencyPrevious version headers omit the leading “Version ” keyword. For uniformity, drop it here or add it everywhere.
-Version 9.0.5 +9.0.5
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
.docfx/Dockerfile.docfx(2 hunks).github/workflows/pipelines.yml(2 hunks).nuget/Codebelt.Extensions.Swashbuckle.AspNetCore/PackageReleaseNotes.txt(1 hunks)CHANGELOG.md(1 hunks)Directory.Packages.props(1 hunks)testenvironments.json(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: call-test (windows-2022, Release) / 🧪 Test
- GitHub Check: call-test (ubuntu-24.04, Debug) / 🧪 Test
- GitHub Check: call-test (windows-2022, Debug) / 🧪 Test
- GitHub Check: call-test (ubuntu-24.04, Release) / 🧪 Test
🔇 Additional comments (4)
.github/workflows/pipelines.yml (1)
65-72: Pin the reusable workflow version to a commit SHA for deterministic buildsSwitching the SonarCloud job to
@v2is welcome, but a floating major-version tag can silently pick up breaking changes. For long-lived pipelines, pin to a commit SHA or release tag and update explicitly:-uses: codebeltnet/jobs-sonarcloud/.github/workflows/default.yml@v2 +uses: codebeltnet/jobs-sonarcloud/.github/workflows/[email protected] # or specific SHA.docfx/Dockerfile.docfx (1)
13-14: Keep platform flag consistentYou used
--platform=$BUILDPLATFORMfor thebasestage but not for thefinalstage.
If multi-arch images are a goal, mirror the flag:-FROM nginx:${NGINX_VERSION} AS final +FROM --platform=$BUILDPLATFORM nginx:${NGINX_VERSION} AS finaltestenvironments.json (1)
10-13: LGTM – image tag bumpUpdating the Ubuntu runner image to
net8.0.412-9.0.302aligns with the package version bumps and keeps test parity. No issues spotted.Directory.Packages.props (1)
6-10: Verified: all projects target net9.0—safe to use 9.x packagesA scan of every *.csproj found only net9.0 frameworks (e.g.
tooling/WebApiExample/WebApiExample.csproj: net9.0). No net8.0 (or lower) targets remain, so bumping to the 9.x preview packages won’t break any consumers.
| name: call-codeql | ||
| needs: [build,test] | ||
| uses: codebeltnet/jobs-codeql/.github/workflows/default.yml@v1 | ||
| uses: codebeltnet/jobs-codeql/.github/workflows/default.yml@v2 | ||
| permissions: | ||
| security-events: write | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Same pinning advice applies to the CodeQL job
For the same reasons as above, consider locking the CodeQL reusable workflow to an explicit tag/SHA to avoid unexpected failures when v2 changes.
-uses: codebeltnet/jobs-codeql/.github/workflows/default.yml@v2
+uses: codebeltnet/jobs-codeql/.github/workflows/[email protected] # or specific SHA📝 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.
| name: call-codeql | |
| needs: [build,test] | |
| uses: codebeltnet/jobs-codeql/.github/workflows/default.yml@v1 | |
| uses: codebeltnet/jobs-codeql/.github/workflows/default.yml@v2 | |
| permissions: | |
| security-events: write | |
| name: call-codeql | |
| needs: [build,test] | |
| uses: codebeltnet/jobs-codeql/.github/workflows/[email protected] # or specific SHA | |
| permissions: | |
| security-events: write |
🧰 Tools
🪛 YAMLlint (1.37.1)
[warning] 84-84: too few spaces after comma
(commas)
🤖 Prompt for AI Agents
In .github/workflows/pipelines.yml around lines 83 to 88, the CodeQL job uses a
reusable workflow pinned to the floating tag 'v2', which can lead to unexpected
failures if that tag changes. Update the 'uses' field to reference a specific
commit SHA or an explicit version tag instead of 'v2' to ensure consistent and
stable workflow execution.
|
1 participant
This pull request includes updates across several areas of the codebase, focusing on dependency upgrades, workflow improvements, and Docker configuration enhancements. The changes aim to ensure compatibility with the latest versions, improve maintainability, and streamline CI/CD processes.
Dependency Updates:
Directory.Packages.props: Upgraded multiple package versions, includingCodebelt.Bootstrapper.Web(4.0.2),Codebelt.Extensions.Xunit.App(10.0.4),Cuemon.Extensions.AspNetCore.Mvc.Formatters.Text.Json(9.0.7),Microsoft.AspNetCore.OpenApi(9.0.7), andSwashbuckle.AspNetCore(9.0.3). These updates ensure compatibility with the latest features and bug fixes..nuget/Codebelt.Extensions.Swashbuckle.AspNetCore/PackageReleaseNotes.txt: Updated release notes for version 9.0.5, highlighting dependency upgrades for all supported target frameworks.testenvironments.json: Updated Docker image reference for the Ubuntu test runner tonet8.0.412-9.0.302.Workflow Improvements:
.github/workflows/pipelines.yml: Updated thesonarcloudandcodeqljob configurations to use versionv2of the respective workflows, ensuring compatibility with the latest CI/CD standards. [1] [2]Docker Configuration Enhancements:
.docfx/Dockerfile.docfx: Introduced anARGforNGINX_VERSIONand updated the base and final stages to use the new variable, improving flexibility and maintainability of the Dockerfile. [1] [2]Summary by CodeRabbit