Fix NuGet restore loop with CPM for SqlDatabaseProjects#1291
Fix NuGet restore loop with CPM for SqlDatabaseProjects#1291almostchristian wants to merge 1 commit intoCommunityToolkit:mainfrom
Conversation
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/CommunityToolkit/Aspire/main/eng/scripts/dogfood-pr.sh | bash -s -- 1291Or
iex "& { $(irm https://raw.githubusercontent.com/CommunityToolkit/Aspire/main/eng/scripts/dogfood-pr.ps1) } 1291" |
There was a problem hiding this comment.
Pull request overview
Fixes a NuGet restore loop/circular dependency affecting CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects when consumers use Central Package Management (Directory.Packages.props) by marking build-injected PackageReferences as implicitly defined.
Changes:
- Add
IsImplicitlyDefined="true"toMicrosoft.Build*package references injected via the integration’s.propsfile to prevent CPM from treating them as explicit references.
| <PackageReference Include="Microsoft.Build" Version="17.11.48" PrivateAssets="true" ExcludeAssets="all" IsImplicitlyDefined="true" /> | ||
| <PackageReference Include="Microsoft.Build.Framework" Version="17.11.48" PrivateAssets="true" ExcludeAssets="all" IsImplicitlyDefined="true" /> | ||
| <PackageReference Include="Microsoft.NET.StringTools" Version="17.11.48" PrivateAssets="true" ExcludeAssets="all" IsImplicitlyDefined="true" /> |
There was a problem hiding this comment.
PrivateAssets is set to "true" on these PackageReferences. NuGet/MSBuild expects PrivateAssets to be an asset list (typically all/All); using true is likely treated as an unknown asset and effectively no-op, which can leak these references transitively when a consuming project is packed. Consider changing to PrivateAssets="All" (or <PrivateAssets>all</PrivateAssets>) to match the repo’s usage (e.g., src/Directory.Build.props).
| <PackageReference Include="Microsoft.Build" Version="17.11.48" PrivateAssets="true" ExcludeAssets="all" IsImplicitlyDefined="true" /> | |
| <PackageReference Include="Microsoft.Build.Framework" Version="17.11.48" PrivateAssets="true" ExcludeAssets="all" IsImplicitlyDefined="true" /> | |
| <PackageReference Include="Microsoft.NET.StringTools" Version="17.11.48" PrivateAssets="true" ExcludeAssets="all" IsImplicitlyDefined="true" /> | |
| <PackageReference Include="Microsoft.Build" Version="17.11.48" PrivateAssets="All" ExcludeAssets="all" IsImplicitlyDefined="true" /> | |
| <PackageReference Include="Microsoft.Build.Framework" Version="17.11.48" PrivateAssets="All" ExcludeAssets="all" IsImplicitlyDefined="true" /> | |
| <PackageReference Include="Microsoft.NET.StringTools" Version="17.11.48" PrivateAssets="All" ExcludeAssets="all" IsImplicitlyDefined="true" /> |
There was a problem hiding this comment.
@almostchristian Might be worth investigating this suggestion as well
|
LGTM - looking foward to @jmezach 's comments |
|
@almostchristian please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ), 1. Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, “Project” means any of the projects owned or managed by .NET Foundation and offered under a license “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any “Submission” means the Code and any other copyrightable material Submitted by You, including any 2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any 3. Originality of Work. You represent that each of Your Submissions is entirely Your 4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else 5. Licenses. a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. 6. Representations and Warranties. You represent that You are legally entitled to grant the above 7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or 8. Information about Submissions. You agree that contributions to Projects and information about 9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and 10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and .NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1. |
Closes #1065
Fixes a NuGet restore loop / circular dependency when using Central Package Management (
Directory.Packages.props) withCommunityToolkit.Aspire.Hosting.SqlDatabaseProjects.This updates the props file in
CommunityToolkit.Aspire.Hosting.SqlDatabaseProjectsto mark the PackageReferences as implicitly defined (IsImplicitlyDefined="true"), preventing CPM from treating them as explicit references and thrashing during restore.Fixes #1065
PR Checklist
Other information
Discussion on the IsImplicitlyDefined property and its relationship with CPM NuGet/Home#13529