Skip to content

#3320 switch sourcelink to private #3321

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

#3320 switch sourcelink to private #3321

wants to merge 1 commit into from

Conversation

thompson-tomo
Copy link

@thompson-tomo thompson-tomo commented May 29, 2025 •
edited by coderabbitai bot
Loading

Closes #3320

Summary by CodeRabbit

  • Chores

    • Removed redundant package references to Microsoft.SourceLink.GitHub from multiple project files.
    • Applied minor formatting improvements to project configuration files for consistency.

  • Style

    • Cleaned up whitespace and standardized formatting in several project files.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 29, 2025 •
edited
Loading

Walkthrough

The changes consolidate the Microsoft.SourceLink.GitHub package reference by removing it from individual project files and adding it to the central Directory.Build.props file with PrivateAssets=all. Minor XML formatting adjustments were also made to some package references, but no changes were made to public code entities or functionality.

Changes

Files/Groups Change Summary
src/Directory.Build.props Added centralized Microsoft.SourceLink.GitHub package reference with PrivateAssets=all.
All *.csproj files except Directory.Build.props (e.g., Shesha.Application.csproj, etc.) Removed individual Microsoft.SourceLink.GitHub package references.
Several *.csproj files (e.g., Shesha.Core.csproj, Shesha.Elmah.csproj, etc.) Reformatted AsyncFixer and IDisposableAnalyzers package references for XML consistency.

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Ensure Microsoft.SourceLink.GitHub is a dev-only dependency and not listed on nuget.org (#3320) ✅

Poem

In the warren of code, I hop with glee,
Tidying packages for all to see!
SourceLink now tucked away,
Only for devs, not on display.
With whitespace trimmed and XML neat,
This rabbit’s work is now complete!
🐇✨

📜 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 d3b615a and 701e49f.

📒 Files selected for processing (18)
  • shesha-core/src/Directory.Build.props (1 hunks)
  • shesha-core/src/Shesha.Application/Shesha.Application.csproj (0 hunks)
  • shesha-core/src/Shesha.Common/Shesha.Common.csproj (0 hunks)
  • shesha-core/src/Shesha.Core/Shesha.Core.csproj (1 hunks)
  • shesha-core/src/Shesha.Elmah/Shesha.Elmah.csproj (1 hunks)
  • shesha-core/src/Shesha.FluentMigrator/Shesha.FluentMigrator.csproj (0 hunks)
  • shesha-core/src/Shesha.Framework/Shesha.Framework.csproj (0 hunks)
  • shesha-core/src/Shesha.GraphQL/Shesha.GraphQL.csproj (1 hunks)
  • shesha-core/src/Shesha.Import/Shesha.Import.csproj (1 hunks)
  • shesha-core/src/Shesha.MongoRepository/Shesha.MongoRepository.csproj (1 hunks)
  • shesha-core/src/Shesha.NHibernate.PostGis/Shesha.NHibernate.PostGis.csproj (0 hunks)
  • shesha-core/src/Shesha.NHibernate/Shesha.NHibernate.csproj (2 hunks)
  • shesha-core/src/Shesha.RestSharp/Shesha.RestSharp.csproj (1 hunks)
  • shesha-core/src/Shesha.Scheduler/Shesha.Scheduler.csproj (1 hunks)
  • shesha-core/src/Shesha.Sms.Clickatell/Shesha.Sms.Clickatell.csproj (1 hunks)
  • shesha-core/src/Shesha.Web.Core/Shesha.Web.Core.csproj (1 hunks)
  • shesha-core/src/Shesha.Web.FormsDesigner/Shesha.Web.FormsDesigner.csproj (0 hunks)
  • shesha-core/src/Shesha.Web.Host/Shesha.Web.Host.csproj (0 hunks)
💤 Files with no reviewable changes (7)
  • shesha-core/src/Shesha.Common/Shesha.Common.csproj
  • shesha-core/src/Shesha.FluentMigrator/Shesha.FluentMigrator.csproj
  • shesha-core/src/Shesha.NHibernate.PostGis/Shesha.NHibernate.PostGis.csproj
  • shesha-core/src/Shesha.Web.FormsDesigner/Shesha.Web.FormsDesigner.csproj
  • shesha-core/src/Shesha.Framework/Shesha.Framework.csproj
  • shesha-core/src/Shesha.Application/Shesha.Application.csproj
  • shesha-core/src/Shesha.Web.Host/Shesha.Web.Host.csproj
🔇 Additional comments (22)
shesha-core/src/Shesha.Import/Shesha.Import.csproj (2)

27-29: Consistent AsyncFixer metadata formatting
Explicit <PrivateAssets> and <IncludeAssets> tags are correctly applied to the AsyncFixer reference, aligning with analyzer packaging best practices.

32-34: Consistent IDisposableAnalyzers metadata formatting
The IDisposableAnalyzers package now explicitly specifies <PrivateAssets> and <IncludeAssets>, ensuring analyzer assets are scoped properly.

shesha-core/src/Directory.Build.props (1)

15-18: Centralize SourceLink package reference
Adding Microsoft.SourceLink.GitHub with PrivateAssets="all" and scoped <IncludeAssets> to Directory.Build.props centralizes SourceLink management across the solution.

shesha-core/src/Shesha.Sms.Clickatell/Shesha.Sms.Clickatell.csproj (2)

22-24: Standardize AsyncFixer reference formatting
The AsyncFixer package reference now includes explicit analyzer metadata, matching the solution’s conventions.

26-28: Standardize IDisposableAnalyzers reference formatting
Explicit <PrivateAssets> and <IncludeAssets> ensure analyzer assets are correctly isolated in downstream consumers.

shesha-core/src/Shesha.Scheduler/Shesha.Scheduler.csproj (2)

32-34: Standardize AsyncFixer reference formatting
Explicit analyzer metadata tags maintain consistency across project files.

40-42: Standardize IDisposableAnalyzers reference formatting
Ensures IDisposableAnalyzers assets are scoped via <PrivateAssets> and <IncludeAssets>.

shesha-core/src/Shesha.Web.Core/Shesha.Web.Core.csproj (2)

43-45: Standardize AsyncFixer reference formatting
The update applies explicit analyzer metadata, aligning with other projects’ packaging rules.

48-50: Standardize IDisposableAnalyzers reference formatting
Explicit <PrivateAssets> and <IncludeAssets> tags ensure analyzer assets are handled consistently.

shesha-core/src/Shesha.MongoRepository/Shesha.MongoRepository.csproj (2)

23-25: Consistent formatting for AsyncFixer PackageReference
The XML for the AsyncFixer analyzers has been cleaned up—indentation and tag grouping now match the repository-wide style. No functional attributes or versions were changed.

27-29: Consistent formatting for IDisposableAnalyzers PackageReference
Similarly, the IDisposableAnalyzers entry was reformatted for consistent indentation and tag structure. This is purely cosmetic.

shesha-core/src/Shesha.Core/Shesha.Core.csproj (2)

48-50: Standardize AsyncFixer PackageReference formatting
AsyncFixer’s <PackageReference> has been reformatted to match the other projects’ XML style. No behavior or asset inclusion has changed.

52-54: Standardize IDisposableAnalyzers PackageReference formatting
IDisposableAnalyzers has received the same formatting cleanup. Versions and private/include assets remain untouched.

shesha-core/src/Shesha.GraphQL/Shesha.GraphQL.csproj (2)

21-23: Align AsyncFixer formatting with repository conventions
The multiline formatting for AsyncFixer now matches the style used in other .csproj files, improving readability.

29-32: Align IDisposableAnalyzers formatting with repository conventions
The IDisposableAnalyzers block is now consistently indented and structured. No functional changes introduced.

shesha-core/src/Shesha.RestSharp/Shesha.RestSharp.csproj (2)

15-17: Normalize AsyncFixer PackageReference formatting
Updated indentation and tag layout for AsyncFixer to match the common pattern across projects.

19-21: Normalize IDisposableAnalyzers PackageReference formatting
IDisposableAnalyzers formatting has been aligned with the rest of the codebase’s style.

shesha-core/src/Shesha.Elmah/Shesha.Elmah.csproj (2)

16-18: Cleanup AsyncFixer PackageReference formatting
Refactored the AsyncFixer entry for consistent indentation and grouping of child elements without altering its configuration.

21-23: Cleanup IDisposableAnalyzers PackageReference formatting
Reformatted the IDisposableAnalyzers block to align with the project-wide XML style.

shesha-core/src/Shesha.NHibernate/Shesha.NHibernate.csproj (3)

27-29: Approve PackageReference formatting for AsyncFixer

The AsyncFixer package reference retains its version and assets configuration in a clear multi-line structure, consistent with other analyzer dependencies.

34-36: Approve PackageReference formatting for IDisposableAnalyzers

The IDisposableAnalyzers package reference is correctly configured with <PrivateAssets> and <IncludeAssets> and matches the established style.

59-59: Approve repositioning of the Services\Dtos\ folder

Moving the <Folder Include="Services\Dtos\" /> element directly under the previous <ItemGroup> is purely structural and does not affect build behavior.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Dev dependencies being included
1 participant
@thompson-tomo