ChatGPT解决这个技术问题 Extra ChatGPT

Build NuGet Package automatically including referenced dependencies

I want to run a local/internal NuGet repository. I think I've figured out how to "reuse" existing NuGet packages by including them in a dummy project using NuGet and scanning the package file to grab my locally-cached .nupkg files, but...

How do you create a nuget package (.nupkg) from a project, automatically including all dll dependencies and not just those grabbed via NuGet?

Specifically:

Create a solution Add a new Project Add references to various .dll files/other projects <-- this is the missing part Add NuGet packages via package manager / cmdline / whatever something automatically creates the .nupkg

From what I've found, you're supposed to do things like

manually edit your .csproj file to add true to include dependencies

manually create a .nuspec file and manually list your dependencies (similar ?)

manually run nuget pack on your .nuspec file

But everything is manual, which is stupid. Even the semi-automatic solutions are still awkward or half-manual:

Create .nuspec templates - doesn't seem to include dependencies, just metadata

nuget pack via build-event (step #5), which you need to add manually to every project, and it has its own quirks: "$(SolutionDir).nuget\NuGet.exe" pack "$(ProjectPath)" -Properties Configuration=Release move /Y *.nupkg "$(TargetDir)"

I'll settle for something that automatically creates a .nuspec manifest from project references. Then theoretically that + the nuget build-event can be rolled up into a build-project/nuget package, which is what I really want to see.

I just came across this VS extension eyecatch.no/projects/nuget-package-template which I'll need to look into...
Five years later and nuget 4.x spec or pack still can't determine dependencies.
Is there an update for this issue? Or do you still have these problems?
I gave up on this a while ago, but check out NuProj as reported by this answer
This issue still exists. :(

J
Jess

Your point #3 (Add references to various .dll files/other projects <-- this is the missing part) really contains two different issues: (1) add references to various dll files, and (2) add references to other projects in the same solution.

Number (2) here has gotten some added support as of NuGet 2.5. You can add an option to include references to other projects in the same solution when creating a NuGet package for a project:

nuget pack projectfile.csproj -IncludeReferencedProjects

If projectfile.csproj references any other projects in your solution that also is exposed as NuGet packages, these projects' NuGet packages will be added as dependencies.

If it references projects in your solution that doesn't expose themselves as NuGet packages, their dlls will be included in this NuGet package.

As for (1), if you find yourself often adding dlls to your projects that aren't available as NuGet packages, you could just create your own (internal) NuGet packages with these files. If you then add these dlls as a NuGet package instead of the files directly, this NuGet package will be a dependency in your project's NuGet package.


sigh #1 is still too manual for my tastes. Actually, "create your own (internal) NuGet package with these files" is what I'm trying to do -- the whole point of this question is that I want to automatically roll up non-NuGet .dlls into a NuGet package. Not go through and list each dll manually in a .nuspec, which I think is what you're suggesting?
You don't have to specify each DLL separately. That would indeed be much work if you have many of them. When listing files to include, you can use (recursive) wildcards (docs.nuget.org/docs/reference/…), so if you for instance place all these DLLs in a separate folder, it would be a one-liner to include them all.
It won't automatically pick up whatever is in your bin directory, you'd have to specify it explicitly, something like this: <file src="bin\release\*.dll" target="lib" />
Note worthy, if the projects being referenced happen to have a nuspec file then nuget will treat that as a package and NOT include in the lib folder but will add it to the package dependencies
Is there an equivalent to IncludeReferencedProjects for .csproj?
j
joelc

I found a well-written article on this topic. I have the same issue with certain packages that have a hierarchy of dependencies and up until now I've been uploading each as a separate NuGet package (what. a. waste. of. time)

I've just tested the solution found here: https://dev.to/wabbbit/include-both-nuget-package-references-and-project-reference-dll-using-dotnet-pack-2d8p

And after examining the NuGet package using NuGet Package Explorer, the DLLs produced by referenced projects are indeed present. I'm going to test by actually submitting this package to NuGet and testing it.

Here's my source in case it is helpful to you: https://github.com/jchristn/NuGetPackTest

And the test NuGet package: https://www.nuget.org/packages/NuGetPackTest/1.0.0

The solution appears to work well. I don't know what it's going to look like when there are layers of references, I'm sure it could get really hairy and really fast.

https://i.stack.imgur.com/xm4yN.png

.csproj from NuGetPackTest library which references project TestLibrary (portions removed for brevity)

<Project Sdk="Microsoft.NET.Sdk">
 
  <PropertyGroup>
    <TargetFrameworks>netstandard2.0;netcoreapp3.0;netcoreapp3.1;net461</TargetFrameworks>
    ...
    <GeneratePackageOnBuild>true</GeneratePackageOnBuild>

    <!-- added this line -->
    <TargetsForTfmSpecificBuildOutput>$(TargetsForTfmSpecificBuildOutput);CopyProjectReferencesToPackage</TargetsForTfmSpecificBuildOutput>
  </PropertyGroup>

  <ItemGroup>

    <!-- modified this ProjectReference to include the children ReferenceOutputAssembly and IncludeAssets -->
    <ProjectReference Include="..\TestLibrary\TestLibrary.csproj">
      <ReferenceOutputAssembly>true</ReferenceOutputAssembly>
      <IncludeAssets>TestLibrary.dll</IncludeAssets>
    </ProjectReference>
  </ItemGroup>

  <!-- added this section -->
  <Target DependsOnTargets="ResolveReferences" Name="CopyProjectReferencesToPackage">
    <ItemGroup>
      <BuildOutputInPackage Include="@(ReferenceCopyLocalPaths->WithMetadataValue('ReferenceSourceTarget', 'ProjectReference'))"/>
    </ItemGroup>
  </Target>
  
</Project>

This solution does not add the reference project's nuget dependencies as dependencies. So you will have to add all the nuget dependencies that are added in sub-projects to the main project that will be a nuget package. Atleast that is what I encountered, including the created nuget package in another project results in 'assembly or file not found' issues.
J
John Gietzen

For other Googlers, you can use this if you are using the NuGet.targets file to run NuGet Pack:

<Target Name="PrePackage" BeforeTargets="BuildPackage">
  <PropertyGroup>
    <BuildCommand>$(BuildCommand) -IncludeReferencedProjects</BuildCommand>
  </PropertyGroup>
</Target>

Sounds promising but not enough information to actually implement. What is this NuGet.targets file you speak of? I am familiar with build target files in general but not this specific use case
Also intersted how NuGet.targets can help, perhaps this notification will help in getting an answer update :)
Downvoted as I don't think this comment has aged well with time.
upvoted because aging time is not a valid criteria to downvote
S
SharpC

Check this out!

The solution which I found is an extension for Visual Studio: https://visualstudiogallery.msdn.microsoft.com/fbe9b9b8-34ae-47b5-a751-cb71a16f7e96/view/Reviews

https://i.stack.imgur.com/dAtYk.png

Then you are adding interesting you projects to references and BOOOM !! All dependencies and file directories are automatically added. If you want to modify NuSpec data you click right at project and go to Properties, then modify what you want. Generated NuSpec and nupkg will be in folder obj of your new project. I hope it helps ;).


Is there also a solution for VS2017?
This does not work in case of generating the packages on build server.
Too bad this is deprecated. Would have been useful.
I found a VS2017 version: marketplace.visualstudio.com/… and VS2019 version: marketplace.visualstudio.com/items?itemName=kamalraj.Nuproj201, although didn't have much luck on initial testing so just created the file manually in the end.
P
PainElemental

I solved this for my case by adding the whole TargetDir to the nuget package. Just add this to the .csproj :

<Target Name="IncludeAllFilesInTargetDir" AfterTargets="Build">
  <ItemGroup>
    <None Include="$(TargetDir)\**">
      <Pack>true</Pack>
      <PackagePath>tools</PackagePath>
    </None>
  </ItemGroup>
</Target>