Skip to content

chore: group dependencies by usage and mark dev-only packages as private #254

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 1 commit into from
Jun 7, 2025

Conversation

nanotaboada
Copy link
Owner

@nanotaboada nanotaboada commented Jun 7, 2025

Summary by CodeRabbit

  • Chores
    • Updated dependency management configuration for improved clarity and organization.
    • Standardized commit message format for automated dependency updates.
    • Refined grouping of dependencies in project files, separating development, runtime, and test dependencies.
    • Updated and cleaned up several package versions for both main and test projects.

Copy link

coderabbitai bot commented Jun 7, 2025

Walkthrough

This change updates package management configurations and project dependencies. The Dependabot configuration is standardized for commit messages and update groups. The main project and test project files are reorganized to clarify dependency scopes, update package versions, and remove or add specific package references, without altering any public APIs.

Changes

File(s) Change Summary
.github/dependabot.yml Standardized NuGet commit message format; updated update groups, removed "efcore" group, added "xunit" group.
src/Dotnet.Samples.AspNetCore.WebApi/Dotnet.Samples.AspNetCore.WebApi.csproj Reorganized dependencies into development/runtime groups; removed some EFCore packages; updated Swashbuckle version.
test/Dotnet.Samples.AspNetCore.WebApi.Tests/Dotnet.Samples.AspNetCore.WebApi.Tests.csproj Updated and reorganized test dependencies; added Moq and FluentAssertions; removed duplicates; version bumps.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant Dependabot
    participant Repo

    Developer->>Repo: Update .csproj and dependabot.yml
    Dependabot->>Repo: Create PR with standardized commit message
    Developer->>Repo: Merge PR
Loading

Possibly related PRs

Suggested labels

dependencies, .NET


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f8a1d7a and 40b80c8.

📒 Files selected for processing (3)
  • .github/dependabot.yml (2 hunks)
  • src/Dotnet.Samples.AspNetCore.WebApi/Dotnet.Samples.AspNetCore.WebApi.csproj (1 hunks)
  • test/Dotnet.Samples.AspNetCore.WebApi.Tests/Dotnet.Samples.AspNetCore.WebApi.Tests.csproj (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Codacy Static Code Analysis
  • GitHub Check: Analyze (csharp)
🔇 Additional comments (6)
test/Dotnet.Samples.AspNetCore.WebApi.Tests/Dotnet.Samples.AspNetCore.WebApi.Tests.csproj (1)

11-23: Group and isolate test-only packages
The <ItemGroup Label="Test dependencies"> cleanly consolidates all test frameworks and utilities. Using <PrivateAssets>all</PrivateAssets> on each PackageReference correctly prevents these packages from being transitively exposed to consumers. Versions are aligned and up-to-date.

src/Dotnet.Samples.AspNetCore.WebApi/Dotnet.Samples.AspNetCore.WebApi.csproj (2)

10-17: Isolate development dependencies
Moving code-generation and EF-Core design packages into a “Development dependencies” group with <PrivateAssets>all</PrivateAssets> is the right approach to avoid transitive exposure of tooling packages.


19-25: Validate runtime dependency updates
The “Runtime dependencies” group now exclusively holds production packages, including the Swashbuckle bump to 8.1.4. Before merging, please confirm that removing EF Core InMemory/SqlServer and adding Sqlite covers all runtime scenarios and doesn’t break existing database logic or integration tests.

Also applies to: 29-29

.github/dependabot.yml (3)

9-11: Standardize commit messages for source updates
Adding include: scope and prefix: "chore(deps): " ensures NuGet update PRs in the source directory follow a consistent format.


21-23: Apply consistent commit message settings to tests
Mirroring the same commit-message configuration in the test directory improves readability and historical tracking for test package updates.


24-27: Group xunit packages under a dedicated Dependabot group
Defining an xunit group for xunit* patterns will streamline dependency updates for the core test framework.


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

sonarqubecloud bot commented Jun 7, 2025

Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
-18.28%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (f8a1d7a) 1072 196 18.28%
Head commit (40b80c8) 0 (-1072) 0 (-196) 0.00% (-18.28%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#254) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

@nanotaboada nanotaboada merged commit d73f5e7 into master Jun 7, 2025
17 checks passed
@nanotaboada nanotaboada deleted the feature/csproj branch June 7, 2025 23:49
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