Skip to content

V9.0.3/package maintenance #12

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 4 commits into from
May 25, 2025
Merged

V9.0.3/package maintenance #12

merged 4 commits into from
May 25, 2025

Conversation

gimlichael
Copy link
Member

@gimlichael gimlichael commented May 25, 2025

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

  • Updated several package versions in Directory.Packages.props, including Codebelt.Extensions.AspNetCore.Mvc.Formatters.Newtonsoft.Json (9.0.3), Cuemon.AspNetCore (9.0.5), and xunit.runner.visualstudio (3.1.0), to ensure compatibility with the latest frameworks and tools.

Docker Configuration

  • Updated the base image in .docfx/Dockerfile.docfx to use nginx:1.27.5-alpine and codebeltnet/docfx:2.78.3 for improved security and compatibility.

CI/CD Workflow Simplification

  • Simplified the .github/workflows/pipelines.yml by replacing inline job definitions with reusable workflows for build, pack, and test stages. This reduces redundancy and centralizes workflow logic.
  • Updated the call-nuget job to use the codebeltnet/jobs-nuget-push reusable workflow for better alignment with the naming convention.

Documentation Updates

  • Added a new entry for version 9.0.3 in CHANGELOG.md and updated PackageReleaseNotes.txt to reflect dependency upgrades and availability for .NET 8 and 9. [1] [2]

Test Environment

  • Updated the Docker image in testenvironments.json to gimlichael/ubuntu-testrunner:net8.0.409-9.0.300 for testing with the latest runtime versions.

Summary by CodeRabbit

  • Chores

    • Updated package dependencies to the latest compatible versions.
    • Upgraded Docker and test environment images for improved compatibility and support.
    • Streamlined CI pipeline by modularizing workflow steps and leveraging reusable workflows.
  • Documentation

    • Added release notes and changelog entries for version 9.0.3, highlighting updated dependencies and .NET 8/9 availability.

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

coderabbitai bot commented May 25, 2025

Walkthrough

This 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

Files/Group Change Summary
.docfx/Dockerfile.docfx Upgraded nginx and docfx build images, added multi-platform support, simplified final stage image reference.
.github/workflows/pipelines.yml Refactored to use reusable workflow calls for build, pack, test, and deploy jobs, removing inline job steps.
Directory.Packages.props Updated minor/patch versions for multiple dependencies and test packages.
.nuget/Codebelt.Extensions.Asp.Versioning/PackageReleaseNotes.txt, CHANGELOG.md Added entries for version 9.0.3, noting dependency updates and .NET 9/.NET 8 availability.
testenvironments.json Updated Docker image tag for "Docker-Ubuntu" test environment.

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
Loading

Possibly related PRs

Poem

A hop, a skip, a version jump,
With Docker fresh and pipelines plump.
Dependencies rise, the changelog grows,
The rabbit’s code garden ever glows.
From test to pack, all neat and spry,
Another update—let’s multiply! 🐇✨


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 89.69%. Comparing base (5f0f404) to head (eaf60a5).
Report is 1 commits behind head on main.

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.
📢 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: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5f0f404 and eaf60a5.

📒 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
The xunit.runner.visualstudio package was updated from 3.0.2 → 3.1.0—a major version change. Please verify compatibility with the existing xunit core (2.9.3) and ensure CI test jobs still execute without errors.

CHANGELOG.md (1)

10-13: Changelog entry follows convention
The new 9.0.3 entry 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 for Docker-Ubuntu has been bumped to net8.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 new Version 9.0.3 section clearly states .NET 8/9 support and dependency upgrades, in line with Directory.Packages.props.

.docfx/Dockerfile.docfx (1)

1-4: Upgrade Docker base images and enable multi-platform builds
Switched to --platform=$BUILDPLATFORM and bumped to nginx: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 workflow

The build job now delegates to codebeltnet/jobs-dotnet-build with 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 workflow

The pack job correctly calls codebeltnet/jobs-dotnet-pack with 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 workflow

The test job is streamlined via codebeltnet/jobs-dotnet-test, preserving the OS/configuration matrix and passing build-switches as required. Keeping fail-fast: false ensures all matrix permutations run. Great consistency.


92-93: Update deploy job to use the nuget-push workflow

The deploy job now invokes codebeltnet/jobs-nuget-push and correctly lists its needs dependencies. 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"]
Copy link

Choose a reason for hiding this comment

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

🛠️ 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.

Suggested change
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.

Copy link

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