V9.0.3/package maintenance #10
Conversation
WalkthroughThis update revises dependency versions, test environment Docker images, and documentation across the repository. It upgrades the Changes
Sequence Diagram(s)sequenceDiagram
actor Developer
participant GitHub Actions
participant Reusable Workflow (Build/Pack/Test/Deploy)
participant Docker Build
participant Nginx Container
Developer->>GitHub Actions: Push code / PR
GitHub Actions->>Reusable Workflow (Build): Call build job with parameters
GitHub Actions->>Reusable Workflow (Pack): Call pack job with parameters
GitHub Actions->>Reusable Workflow (Test): Call test job with parameters
GitHub Actions->>Reusable Workflow (Deploy): Call deploy job with parameters
Developer->>Docker Build: Build .docfx Docker image
Docker Build->>Nginx Container: Deploy generated site
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 #10 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 3 3
Lines 86 86
Branches 2 2
=========================================
Hits 86 86 ☔ 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: 0
🧹 Nitpick comments (1)
.docfx/Dockerfile.docfx (1)
11-11: Consider platform consistency across stagesThe final stage omits
--platform=$BUILDPLATFORM. For clarity and reproducibility, you may want to add the same platform flag or document the intentional difference.
📜 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.AwsSignature4/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 (1)
- GitHub Check: call-test (windows-2022, Debug) / 🧪 Test
🔇 Additional comments (10)
Directory.Packages.props (2)
6-9: Approve dependency version upgradesThe updated versions for
Codebelt.Extensions.Xunit.App,Cuemon.AspNetCore.Authentication,Cuemon.Security.Cryptography, andMicrosoft.NET.Test.Sdkcorrectly align with the changelog and PR objectives.
15-15: Approve xunit.runner.visualstudio updateBumping
xunit.runner.visualstudioto3.1.0is consistent with the other test framework components..docfx/Dockerfile.docfx (1)
1-4: Ensure Docker BuildKit supportAdding
--platform=$BUILDPLATFORMfor the base and build stages requires Docker BuildKit. Please verify that both local and CI/CD build environments enable BuildKit; otherwise these flags may be ignored or cause build failures.CHANGELOG.md (1)
10-12: Approve new changelog entryThe
9.0.3section follows the Keep a Changelog format and accurately summarizes the service update focused on package dependencies.testenvironments.json (1)
12-12: Approve updated test Docker imageThe
Docker-Ubuntuenvironment now usesgimlichael/ubuntu-testrunner:net8.0.409-9.0.300, which aligns with the upgraded .NET 8/.NET 9 dependencies..nuget/Codebelt.Extensions.AwsSignature4/PackageReleaseNotes.txt (1)
1-6: Approve release notes for 9.0.3The new
Version 9.0.3entry clearly states availability for .NET 8/.NET 9 and specifies the precise dependency upgrade details, matching the overall PR scope..github/workflows/pipelines.yml (4)
26-34: Refactor build job to reusable workflow: verify inputs and matrix supportThe build job now calls
codebeltnet/jobs-dotnet-build/.github/workflows/default.yml@v1with a strategy matrix and passes inconfigurationandstrong-name-key-filename. This correctly removes inline steps, but please confirm that the reusable workflow you’re invoking supports:
- A
strategy.matrix.configurationinput- The
strong-name-key-filenameparameterIf those inputs aren’t declared in the reusable workflow’s
workflow_call, the build will fail.
38-47: Modular pack job: ensure correct input propagationYou’ve streamlined the pack job to use
codebeltnet/jobs-dotnet-pack/.github/workflows/default.yml@v1, feeding itconfiguration,upload-packed-artifact, andversion(from build outputs). Verify that:
upload-packed-artifact: trueis accepted as a boolean input- The
versionvalue fromneeds.build.outputs.versionis properly declared in the reusable workflowThis ensures your artifacts are published as expected.
49-60: Use reusable test workflow: validate OS matrix and build-switchesThe test job now invokes
codebeltnet/jobs-dotnet-test/.github/workflows/default.yml@v1with a matrix overosandconfiguration, passingruns-onandbuild-switches. Please confirm that:
- The reusable test workflow declares
runs-onas an input and uses it for its own runner- The
build-switches: -p:SkipSignAssembly=truestring is applied correctlyEnsure the downstream workflow signature matches these inputs.
90-91: Deploy stage refactored tojobs-nuget-pushreusable workflowThe deploy job’s
useswas updated tocodebeltnet/jobs-nuget-push/.github/workflows/default.yml@v1, and itsneedslist was expanded. Confirm that the new workflow:
- Defines
versionin itsworkflow_callinputs- Properly sequences after all listed jobs (
build,pack,test,sonarcloud,codecov,codeql)This will prevent any missing dependency issues when pushing to NuGet.
|
This pull request includes updates to dependencies, Docker configurations, CI/CD workflows, and release notes to improve compatibility, streamline processes, and ensure the latest versions are used. Below is a summary of the most important changes:
Dependency Updates
Directory.Packages.props, includingCodebelt.Extensions.Xunit.App,Cuemon.AspNetCore.Authentication,Cuemon.Security.Cryptography, andMicrosoft.NET.Test.Sdk, to their latest versions.testenvironments.jsonto usegimlichael/ubuntu-testrunner:net8.0.409-9.0.300.Dockerfile Enhancements
.docfx/Dockerfile.docfxto include platform-specific builds using the--platformflag and updated the base and build images to newer versions (nginx:1.27.5-alpineandcodebeltnet/docfx:2.78.3).CI/CD Workflow Simplifications
.github/workflows/pipelines.ymlto replace inline job definitions (build,pack,test, andnuget) with reusable workflows fromcodebeltnet/jobs-*. This reduces duplication and centralizes workflow logic. [1] [2]Documentation Updates
9.0.3in.nuget/Codebelt.Extensions.AwsSignature4/PackageReleaseNotes.txt, highlighting dependency upgrades for all supported target frameworks.CHANGELOG.mdto include an entry for version9.0.3, describing it as a service update focused on package dependencies.Summary by CodeRabbit