Skip to content

V9.0.3/package maintenance #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 25, 2025
Merged

V9.0.3/package maintenance #8

merged 3 commits into from
May 25, 2025

Conversation

gimlichael
Copy link
Member

@gimlichael gimlichael commented May 25, 2025

This pull request includes updates to dependencies, build workflows, and documentation. The most significant changes focus on upgrading package versions, streamlining GitHub Actions workflows, and updating changelogs to reflect the latest service updates.

Dependency Updates:

  • Updated multiple package versions in Directory.Packages.props, including Codebelt.Extensions.Xunit.App to 10.0.1, Cuemon.Core to 9.0.5, and Microsoft.NET.Test.Sdk to 17.14.0.
  • Updated Docker image in testenvironments.json to gimlichael/ubuntu-testrunner:net8.0.409-9.0.300.

Build Workflow Improvements:

  • Refactored .github/workflows/pipelines.yml to use reusable workflows for build, pack, and test jobs, significantly reducing redundancy.
  • Updated the nuget job in .github/workflows/pipelines.yml to reference the jobs-nuget-push reusable workflow.

Documentation Updates:

  • Added release notes for version 9.0.3 in .nuget/Codebelt.Unitify/PackageReleaseNotes.txt, highlighting dependency upgrades.
  • Updated CHANGELOG.md with an entry for version 9.0.3, marking it as a service update focused on package dependencies.

Dockerfile Update:

  • Updated .docfx/Dockerfile.docfx to use platform-specific base and build images and upgraded to the latest versions (nginx:1.27.5-alpine and codebeltnet/docfx:2.78.3).

Summary by CodeRabbit

  • Chores
    • Updated package dependencies to the latest compatible versions.
    • Upgraded Docker and test environment images for improved compatibility.
    • Simplified and modernized CI/CD pipeline configuration using reusable workflows.
  • Documentation
    • Added release notes and changelog entries for version 9.0.3, highlighting updated dependencies and service updates.

@gimlichael gimlichael self-assigned this May 25, 2025
Copy link

coderabbitai bot commented May 25, 2025

Walkthrough

This update upgrades several dependencies and Docker images to newer versions, refactors the GitHub Actions pipeline to use reusable workflows, and documents these changes in release notes and the changelog. Test environment Docker tags are also updated. No functional code changes or public API modifications are included.

Changes

File(s) Summary
.docfx/Dockerfile.docfx Upgraded nginx (1.27.3-alpine → 1.27.5-alpine) and docfx build image (2.77.0 → 2.78.3); added multi-platform support.
.github/workflows/pipelines.yml Refactored pipeline jobs to use reusable workflow calls; updated job names and dependencies.
Directory.Packages.props Upgraded package versions: Codebelt.Extensions.Xunit.App, Cuemon.Core, Microsoft.NET.Test.Sdk, xunit.runner.visualstudio.
.nuget/Codebelt.Unitify/PackageReleaseNotes.txt Added release notes for v9.0.3: dependency upgrades for .NET 9/8, no functional changes.
CHANGELOG.md Added v9.0.3 entry: service update focusing on dependency upgrades.
testenvironments.json Updated Docker-Ubuntu test runner image tag to a newer version.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant Reusable Workflows

    Developer->>GitHub Actions: Push code
    GitHub Actions->>Reusable Workflows: Call build workflow
    GitHub Actions->>Reusable Workflows: Call pack workflow (after build)
    GitHub Actions->>Reusable Workflows: Call test workflow (after build)
    GitHub Actions->>Reusable Workflows: Call deploy workflow (after pack)
Loading

Possibly related PRs

Poem

A hop, a skip, a Docker tag anew,
Pipelines refactored, dependencies too!
The rabbit reviews with a satisfied grin,
For freshened up packages are sure to win.
🐇✨

"Onward to builds that run smooth and fast—
With every upgrade, we outpace the past!"


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented May 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.33%. Comparing base (9abb8c6) to head (ffe4848).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main       #8   +/-   ##
=======================================
  Coverage   83.33%   83.33%           
=======================================
  Files          19       19           
  Lines         666      666           
  Branches       51       51           
=======================================
  Hits          555      555           
  Misses        110      110           
  Partials        1        1           

☔ 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
.docfx/Dockerfile.docfx (1)

11-11: Consider specifying build platform for the final stage.

For consistency with the base and build stages, you may add the --platform=$BUILDPLATFORM flag here:

-FROM nginx:1.27.5-alpine AS final
+FROM --platform=$BUILDPLATFORM nginx:1.27.5-alpine AS final
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9abb8c6 and ffe4848.

📒 Files selected for processing (6)
  • .docfx/Dockerfile.docfx (1 hunks)
  • .github/workflows/pipelines.yml (2 hunks)
  • .nuget/Codebelt.Unitify/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)

🔇 Additional comments (10)
Directory.Packages.props (1)

6-8: Approve package version upgrades.

The bumps for Codebelt.Extensions.Xunit.App → 10.0.1, Cuemon.Core → 9.0.5, Microsoft.NET.Test.Sdk → 17.14.0, and xunit.runner.visualstudio → 3.1.0 align with the documented service update and test environment changes.

Also applies to: 14-14

CHANGELOG.md (1)

10-12: Changelog entry for v9.0.3 is accurate and aligns with PR objectives.

The new ## [9.0.3] - 2025-05-25 section correctly describes this release as a service update focused on package dependencies.

testenvironments.json (1)

12-12: Update Docker image tag for Docker-Ubuntu environment.

Changing to gimlichael/ubuntu-testrunner:net8.0.409-9.0.300 ensures the test runner matches the updated SDK and dependencies.

.nuget/Codebelt.Unitify/PackageReleaseNotes.txt (1)

1-5: PackageReleaseNotes updated for v9.0.3 dependencies.

The entry clearly states availability on .NET 9/8 and notes that dependencies have been upgraded to the latest compatible versions, matching the PR’s scope.

.docfx/Dockerfile.docfx (2)

1-1: Base stage updated with explicit build platform and nginx version bump.

Specifying --platform=$BUILDPLATFORM and upgrading to nginx:1.27.5-alpine follows container best practices for multi-arch builds.


4-4: Build stage updated to latest docfx image.

Switching to codebeltnet/docfx:2.78.3 keeps the documentation tooling in sync with the project’s DocFX requirements.

.github/workflows/pipelines.yml (4)

26-34: DRY build job via reusable workflow
Migrating to the codebeltnet/jobs-dotnet-build reusable workflow with a job-level matrix for configuration removes inline steps while still covering both Debug and Release builds. The secrets: inherit directive ensures credentials flow through correctly.


37-46: Centralize package job with reusable workflow
Invoking codebeltnet/jobs-dotnet-pack and supplying upload-packed-artifact: true alongside the version output from the build job aligns with our CI conventions and eliminates duplicated packaging logic.


49-61: Simplify test job by calling reusable workflow
Great refactor to use codebeltnet/jobs-dotnet-test for both Ubuntu and Windows matrices. Please verify that the build-switches input and the runs-on: ${{ matrix.os }} mapping are correctly consumed by the reusable workflow.


90-91: Bring deploy into modern NuGet-push workflow
Switching to codebeltnet/jobs-nuget-push and extending needs to include all quality-gate jobs (sonarcloud, codecov, codeql) ensures that packages are only published after passing analysis and coverage checks.

Copy link

@gimlichael gimlichael merged commit f57b610 into main May 25, 2025
17 checks passed
@gimlichael gimlichael deleted the v9.0.3/package-maintenance branch May 25, 2025 21:09
@coderabbitai coderabbitai bot mentioned this pull request Jun 16, 2025
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.

1 participant