Skip to content

Conversation

gimlichael
Copy link
Member

@gimlichael gimlichael commented Oct 7, 2024

PR Classification

Enhancement and modernization of the project to support .NET 9.0 and .NET 8.0 frameworks, along with documentation updates and code improvements.

PR Summary

This pull request updates the project to support .NET 9.0 and .NET 8.0, introduces asynchronous methods, and enhances documentation.

  • pipelines.yml and Directory.Build.props: Updated to target .NET 9.0 and .NET 8.0,
  • ConsoleHostedService.cs: Replaced synchronous Run method with asynchronous RunAsync and added structured logging,
  • README.md: Added C# examples, a logo, and contributing and license sections,
  • PackageReleaseNotes.txt and CHANGELOG.md: Updated to reflect version 3.0.0 changes and removals,
  • Startup.cs and Program.cs: Modified to use asynchronous methods and updated application URLs.

Summary by CodeRabbit

  • New Features

    • Upgraded support for .NET 9 and .NET 8 across multiple packages.
    • Introduced new methods and classes to enhance functionality, including RunAsync and UseServices.
    • Added practical C# examples to the README files for better developer guidance.
  • Bug Fixes

    • Improved error handling and logging in the ConsoleHostedService.
  • Documentation

    • Enhanced release notes and README files to include contribution guidelines and usage examples.
  • Chores

    • Updated package references to the latest versions for better compatibility and performance.

@gimlichael gimlichael self-assigned this Oct 7, 2024
Copy link

coderabbitai bot commented Oct 7, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces significant updates across multiple files, primarily focusing on upgrading the framework support to .NET 9.0 and enhancing the functionality of various components. Key changes include modifications to the build pipeline configuration, release notes, and README documentation for several packages, as well as structural changes in the codebase such as method renaming and the introduction of new asynchronous methods. The overall adjustments reflect a shift towards improved developer experience and modernized code practices.

Changes

File Change Summary
.github/workflows/pipelines.yml Updated framework matrix from [net8.0, net6.0] to [net9.0, net8.0]. Retained workflow_dispatch for manual triggering.
.nuget/Codebelt.Bootstrapper.Console/PackageReleaseNotes.txt Version updated to 3.0.0, removed support for .NET 6, added RunAsync and UseServices methods, and improved release notes.
.nuget/Codebelt.Bootstrapper.Console/README.md Added "CSharp Example" section with implementation details for console applications.
.nuget/Codebelt.Bootstrapper.Web/PackageReleaseNotes.txt Version updated to 3.0.0, removed support for .NET 6, modified WebStartup class methods.
.nuget/Codebelt.Bootstrapper.Web/README.md Added "CSharp Example" section demonstrating web application implementation.
.nuget/Codebelt.Bootstrapper.Worker/PackageReleaseNotes.txt Version updated to 3.0.0, removed support for .NET 6, added new classes for worker services.
.nuget/Codebelt.Bootstrapper.Worker/README.md Added "CSharp Example" section for worker service implementation.
.nuget/Codebelt.Bootstrapper/PackageReleaseNotes.txt Version updated to 3.0.0, removed support for .NET 6, added new classes and interfaces.
CHANGELOG.md Introduced to document changes across versions, focusing on compatibility with .NET 9.0.
Directory.Build.props Updated TargetFrameworks from net8.0;net6.0 to net9.0;net8.0, modified package references.
Directory.Build.targets Added new target PreparePackageReleaseNotesFromFile, updated ApplyFileVersion to use GITHUB_RUN_NUMBER.
README.md Added sections for contribution guidelines and licensing information.
app/Codebelt.Bootstrapper.Console.App/Startup.cs Renamed Run to UseServices, added RunAsync method for asynchronous operations.
app/Codebelt.Bootstrapper.Web.App/Properties/launchSettings.json Updated applicationUrl to new ports.
app/Codebelt.Bootstrapper.Web.App/Startup.cs Removed ILogger<Startup> from ConfigurePipeline method.
app/Codebelt.Bootstrapper.WebApi.App/Codebelt.Bootstrapper.WebApi.App.csproj Replaced Swashbuckle.AspNetCore with Cuemon.Extensions.Swashbuckle.AspNetCore.
app/Codebelt.Bootstrapper.WebApi.App/Program.cs Changed Main method to asynchronous.
app/Codebelt.Bootstrapper.WebApi.App/Properties/launchSettings.json Updated applicationUrl to new ports.
app/Codebelt.Bootstrapper.WebApp.App/Codebelt.Bootstrapper.WebApp.App.csproj Updated Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation references based on target framework.
app/Codebelt.Bootstrapper.WebMvc.App/Codebelt.Bootstrapper.WebMvc.App.csproj Updated Microsoft.AspNetCore.Mvc.Razor.RuntimeCompilation references for target frameworks.
app/Codebelt.Bootstrapper.Worker.App/Program.cs Changed Main method to asynchronous.
src/Codebelt.Bootstrapper.Console/ConsoleHostedService.cs Removed ILogger<TStartup> from constructor, added asynchronous handling.
src/Codebelt.Bootstrapper.Console/ConsoleProgram.cs Changed access modifier of CreateHostBuilder method.
src/Codebelt.Bootstrapper.Console/ConsoleStartup.cs Removed Run method, added UseServices and RunAsync methods.
src/Codebelt.Bootstrapper.Web/Codebelt.Bootstrapper.Web.csproj Updated Cuemon.Extensions.Hosting package reference version.
src/Codebelt.Bootstrapper.Worker/WorkerStartup.cs Updated XML documentation for constructor parameters.
src/Codebelt.Bootstrapper/Codebelt.Bootstrapper.csproj Updated package references for .NET 9 and removed older versions.
src/Codebelt.Bootstrapper/StartupFactory.cs Minor formatting change in CreateInstance<TStartup> method.

Possibly related PRs

  • V2.0.0/alm+gha #1: The changes in the main PR regarding the update of the .github/workflows/pipelines.yml file are directly related to the modifications in the same file found in PR V2.0.0/alm+gha #1, which also involves defining a new CI/CD pipeline for the project. Both PRs focus on updating the build framework and workflow configurations, specifically transitioning to support .NET 9.0.

Poem

🐰 In the meadow where code does play,
New frameworks bloom, bright as the day.
With hops of joy, we update and cheer,
For .NET 9's magic is finally here!
Bugs be gone, let the features shine,
In the world of code, all will be fine! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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

sonarqubecloud bot commented Oct 7, 2024

@gimlichael gimlichael merged commit 53b5242 into main Oct 7, 2024
11 of 12 checks passed
@gimlichael gimlichael deleted the v3.0.0/dotnet9 branch October 7, 2024 22:47
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