V9.0.0/private assets experiment

[gimlichael]

PR Classification

Package version updates and dependency management improvements.

PR Summary

This pull request updates package versions and refines dependency management by adding PrivateAssets="compile" attributes.

• Directory.Build.props: Updated Codebelt.Extensions.Xunit package to 9.0.0-preview.6,
• Codebelt.Extensions.AspNetCore.Mvc.Formatters.Text.Yaml.csproj: Added PrivateAssets="compile" to Cuemon.AspNetCore.Mvc,
• Codebelt.Extensions.AspNetCore.Text.Yaml.csproj: Added PrivateAssets="compile" to Cuemon.AspNetCore and Cuemon.Extensions.DependencyInjection,
• Codebelt.Extensions.YamlDotNet.csproj: Added PrivateAssets="compile" to Cuemon.Extensions.IO,
• Codebelt.Extensions.AspNetCore.Text.Yaml.Tests.csproj: Updated Codebelt.Extensions.Xunit.Hosting.AspNetCore package to 9.0.0-preview.6.

Summary by CodeRabbit

• New Features

  • Updated package references to the latest preview versions for improved functionality and performance.

• Bug Fixes

  • Adjusted visibility of certain package references to enhance dependency management and reduce potential conflicts.

[coderabbitai]

Walkthrough

The pull request includes updates to various project files, primarily focusing on modifying package references. The Codebelt.Extensions.Xunit package version was updated across multiple projects, while several other packages had the PrivateAssets="compile" attribute added to limit their visibility in downstream projects. These changes ensure that dependency management is more controlled and that the latest versions of certain packages are utilized.

Changes

File	Change Summary
Directory.Build.props	Updated Codebelt.Extensions.Xunit package reference from 9.0.0-preview.4 to 9.0.0-preview.6.
src/Codebelt.Extensions.AspNetCore.Mvc.Formatters.Text.Yaml/...csproj	Added PrivateAssets="compile" to Cuemon.AspNetCore.Mvc package reference.
src/Codebelt.Extensions.AspNetCore.Text.Yaml/...csproj	Added PrivateAssets="compile" to Cuemon.AspNetCore and Cuemon.Extensions.DependencyInjection package references.
src/Codebelt.Extensions.YamlDotNet/...csproj	Added PrivateAssets="compile" to Cuemon.Extensions.IO package reference.
test/Codebelt.Extensions.AspNetCore.Text.Yaml.Tests/...csproj	Updated Codebelt.Extensions.Xunit.Hosting.AspNetCore package reference from 9.0.0-preview.4 to 9.0.0-preview.6.

Possibly related PRs

• V9.0.0/net9rc1 support #2: The Directory.Build.props file in this PR also includes updates to package references, specifically the Codebelt.Extensions.Xunit package, which aligns with the changes made in the main PR regarding the version update of the same package.

🐰 In the garden of code, changes bloom bright,
With packages updated, all feels just right.
Dependencies trimmed, like a rabbit's swift hop,
In the world of .NET, we'll never stop!
So here's to the updates, let joy be our guide,
With each little change, we take in our stride! 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 145ae4e and bd118d2.

📒 Files selected for processing (5)

• Directory.Build.props (1 hunks)
• src/Codebelt.Extensions.AspNetCore.Mvc.Formatters.Text.Yaml/Codebelt.Extensions.AspNetCore.Mvc.Formatters.Text.Yaml.csproj (1 hunks)
• src/Codebelt.Extensions.AspNetCore.Text.Yaml/Codebelt.Extensions.AspNetCore.Text.Yaml.csproj (1 hunks)
• src/Codebelt.Extensions.YamlDotNet/Codebelt.Extensions.YamlDotNet.csproj (1 hunks)
• test/Codebelt.Extensions.AspNetCore.Text.Yaml.Tests/Codebelt.Extensions.AspNetCore.Text.Yaml.Tests.csproj (1 hunks)

🔇 Additional comments (5)

test/Codebelt.Extensions.AspNetCore.Text.Yaml.Tests/Codebelt.Extensions.AspNetCore.Text.Yaml.Tests.csproj (1)

11-11: LGTM! Version update aligns with PR objectives.

The update of Codebelt.Extensions.Xunit.Hosting.AspNetCore to version 9.0.0-preview.6 is consistent with the PR objectives. This change keeps the package up-to-date with the latest preview version.

To ensure compatibility, please verify that this version works well with the other packages in the project, particularly Cuemon.Extensions.AspNetCore.Authentication and Cuemon.Extensions.AspNetCore which are at version 9.0.0-preview.9. Run the following script to check for any version discrepancies:

src/Codebelt.Extensions.YamlDotNet/Codebelt.Extensions.YamlDotNet.csproj (1)

13-13: LGTM! Consider stable version and verify downstream projects.

The addition of PrivateAssets="compile" to the Cuemon.Extensions.IO package reference aligns with the PR objectives for improving dependency management. This change will prevent the package from being exposed as a transitive dependency, which can help reduce potential conflicts in projects that reference this one.

Please verify that projects depending on Codebelt.Extensions.YamlDotNet still function correctly after this change. You can use the following script to find projects that reference this one:

Consider using a stable version instead of the preview version (9.0.0-preview.9) for production use, unless there are specific features in the preview that are required.

✅ Verification successful

Verified! No downstream projects reference Codebelt.Extensions.YamlDotNet.

The update to PrivateAssets="compile" for the Cuemon.Extensions.IO package does not impact any other projects, as there are no dependencies on Codebelt.Extensions.YamlDotNet.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Find projects that reference Codebelt.Extensions.YamlDotNet
rg --type csproj -l "Include=\"Codebelt.Extensions.YamlDotNet\""

Length of output: 95

---

Script:

#!/bin/bash
# Find projects that reference Codebelt.Extensions.YamlDotNet
rg 'Include="Codebelt\.Extensions\.YamlDotNet"' --glob '*.csproj' -l

Length of output: 70

src/Codebelt.Extensions.AspNetCore.Mvc.Formatters.Text.Yaml/Codebelt.Extensions.AspNetCore.Mvc.Formatters.Text.Yaml.csproj (1)

14-14: Approve change and verify preview version usage.

The addition of PrivateAssets="compile" to the Cuemon.AspNetCore.Mvc package reference is a good practice for dependency management. It prevents this package from being exposed to projects that depend on this one, while still allowing it to be used for compilation of this project.

However, please note that you're using a preview version (9.0.0-preview.9) of the package. While this is not inherently an issue, it's important to ensure that:

1. This preview version is stable enough for your needs.
2. You have a plan to update to the stable version when it becomes available.

To ensure consistency across the project, let's check if other files are using the same version of this package:

✅ Verification successful

Verified no other projects reference the preview version of Cuemon.AspNetCore.Mvc.

The Cuemon.AspNetCore.Mvc package with version 9.0.0-preview.9 is only referenced in src/Codebelt.Extensions.AspNetCore.Mvc.Formatters.Text.Yaml/Codebelt.Extensions.AspNetCore.Mvc.Formatters.Text.Yaml.csproj. This ensures that the use of a preview version is isolated and does not impact other parts of the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for other occurrences of Cuemon.AspNetCore.Mvc package reference
rg --type xml 'PackageReference Include="Cuemon.AspNetCore.Mvc"' -g '*.csproj'

Length of output: 310

src/Codebelt.Extensions.AspNetCore.Text.Yaml/Codebelt.Extensions.AspNetCore.Text.Yaml.csproj (1)

14-15: LGTM! Consider the implications of PrivateAssets="compile"

The addition of PrivateAssets="compile" to the package references for Cuemon.AspNetCore and Cuemon.Extensions.DependencyInjection is a good practice for managing dependencies. This change prevents compile-time assets of these packages from being exposed to projects that reference this one, potentially reducing unnecessary dependencies in downstream projects.

However, please ensure that this change doesn't unintentionally hide types or functionalities that downstream projects might need. If you're certain that these packages are only needed for internal implementation and shouldn't be exposed, then this change is appropriate.

Also, note that you're using preview versions (9.0.0-preview.9) of these packages. While this is fine for development and testing, ensure that you have a plan to update to stable versions before deploying to production.

Let's verify if similar changes have been made consistently across other project files:

This script will help us verify if the PrivateAssets="compile" attribute has been consistently applied across all relevant project files.

Directory.Build.props (1)

84-84: LGTM! Verify compatibility with other test packages.

The update of Codebelt.Extensions.Xunit to version 9.0.0-preview.6 aligns with the PR objectives. This change appears to be a minor version bump within the preview releases, which is good for keeping the test infrastructure up-to-date.

To ensure compatibility, please verify that this update doesn't introduce any conflicts with other test-related packages. Run the following script to check the versions of all test-related packages:

✅ Verification successful

Please run the following script to list all PackageReference elements in your test projects and verify the versions:

---

Please run the following corrected script to list all PackageReference includes and their versions in test projects:

---

Compatibility Verified with Test Packages

The update of Codebelt.Extensions.Xunit to version 9.0.0-preview.6 does not introduce any conflicts with other test-related packages.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check versions of all test-related packages in the solution

# Test: List all test project files and their package references
fd -e csproj | xargs -I {} sh -c 'echo "Project: {}"; grep "PackageReference Include" "{}" | grep -E "Test|xunit|coverlet"'

Length of output: 743

---

Script:

#!/bin/bash
# Description: List all PackageReference includes and their versions in test projects

# Find all test project files (assuming they are in the 'test' directory)
fd -e csproj test/ | xargs -I {} sh -c 'echo "Project: {}"; grep "PackageReference Include" "{}" | grep "Codebelt.Extensions.Xunit\|xunit\|coverlet"'

Length of output: 479

---

Script:

#!/bin/bash
# Description: List all PackageReference includes and their versions in test projects

# Find all test project files within the 'test/' directory
fd -e csproj . 'test/' | xargs -I {} sh -c 'echo "Project: {}"; grep "PackageReference Include" "{}" | grep "Codebelt.Extensions.Xunit\|xunit\|coverlet"'

Length of output: 472

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.66%. Comparing base (145ae4e) to head (bd118d2).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main       #3   +/-   ##
=======================================
  Coverage   86.66%   86.66%           
=======================================
  Files          15       15           
  Lines         555      555           
  Branches       47       47           
=======================================
  Hits          481      481           
  Misses         74       74           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud