We Keep Coding

Why are the files from the contentFiles folder not getting copied over to the bin folder?

I'm trying to get my sql files from the nuget package to the bin folder of my Application. I was setting up the .nuspec file for it. I can see in the .nuget folder that the sql files are a part of the nuget package but they are not reflected in the bin/Debug folder.
<?xml version="1.0" encoding="utf-8"?>
<package >
<metadata>
<id>$id$</id>
<version>$version$</version>
<title>$title$</title>
<authors>Athi</authors>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>$description$</description>
<copyright>$copyright$</copyright>
<tags>Logger</tags>
<dependencies>
<dependency id="Dapper" version="2.0.123" />
<dependency id="System.Data.SqlClient" version="4.8.3" />
</dependencies>
<contentFiles>
<files include="bin\Release\net6.0\Scripts\*.sql" buildAction="Content" copyToOutput="true" />
</contentFiles>
</metadata>
<files>
<file src="bin\Release\net6.0\Scripts\*.*" target="lib\net6.0\Scripts" />
<file src="bin\Release\net6.0\Scripts\*.*" target="contentFiles\Scripts" />
</files>
</package>

Firstly, according to the docs:
The package project should structure content using the following pattern:
/contentFiles/{codeLanguage}/{TxM}/{any?}
For example:
Language- and framework-agnostic:
/contentFiles/any/any/config.xml
net45 content for all languages
/contentFiles/any/net45/config.xml
C#-specific content for net45 and up
/contentFiles/cs/net45/sample.cs
It doesn't look like you are putting them into the correct directory in your NuGet package.
Secondly, according to the docs, contentFiles is only supported on NuGet 4.0+ with PackageReference. Are you using a high enough version of NuGet? Are you using PackageReference in your project files instead of a packages.config file in your project?
TIP: If you find the documentation is lacking in examples of what you are attempting to do, download some (recently made) real packages from https://nuget.org to locate one that does something similar to what you want and use NuGet Package Explorer to see how the packages are arranged.

How to correctly specify dependency information in nuspec file while creating Nuget package?

I'm trying to create Nuget package from a Visual Studio 2017 class Library first time. It is a .NET Framework 4.6.2 project.
The class library is referencing some other nuget packages, dlls, exes which are in References section under Solution Explorer.
Here are the steps I took after looking at some youtube videos and Microsoft documentation:
Right click project and select Properties.
Build option, set Configuration to Release. Saved and closed project properties.
Opened csproj file and changed Configuration to Release
<Configuration Condition=" '$(Configuration)' == '' ">Release</Configuration>
Now build the project in Release mode. I can see dlls under
MyProject\bin\Release and also under MyProject\bin\Debug
Then I create the spec file using
nuget spec
Opened it and made appropriate changes and then
nuget pack MyProject.nuspec
I am getting number of warnings like both for Debug and Release directory:
WARNING: NU5100: The assembly 'bin\Debug\Encryption.dll' is not inside the 'lib' folder and hence it won't be added as a reference when the package is installed into a project. Move it into the 'lib' folder if it needs to be referenced.
although the Class Library (which I am creating Nuget), has a packages.config and has references:
<?xml version="1.0" encoding="utf-8"?>
<packages>
<package id="Encryption" version="1.1.0" targetFramework="net462" />
...
...
...
<package id="TeraData" version="16.20.8" targetFramework="net462" />
</packages>
Since I am getting warnings, I tried entering dependency information in the nuspec file. Here is what my nuspec file looks like
<?xml version="1.0" encoding="utf-8"?>
<package >
<metadata>
<id>ProjectTitle</id>
<version>1.0.0</version>
<title>ProjectTitle</title>
<authors>auther name</authors>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>desc of package</description>
<releaseNotes>release notes text</releaseNotes>
<copyright>Copyright info</copyright>
<tags>some tages</tags>
<dependencies>
<dependency id="Encryption" version="1.1.0" />
...
<dependency id="TeraData" version="16.20.8" />
</dependencies>
</metadata>
</package>
But still get same warnings. If you can please provide a sample how dependency info in nuspec should look like, that would really help!
Please advise if I'm missing anything!

I think it's just a problem with the command of your nuget pack method.
We usually do not use nuget pack xxx.nusepc command to pack a nuget package because it cannnot pack the realated dll,pdb files including the main nuget project's dll automatically into the nupkg.
You have to write the whole nuspec node with it. You have to write <files> node in nuspec file to include your main project's dll so that it will remove the warning of missing dependencies. You should not add <references> node additionally.
like:
<?xml version="1.0" encoding="utf-8"?>
<package >
<metadata>
<id>ProjectTitle</id>
<version>1.0.0</version>
<title>ProjectTitle</title>
<authors>auther name</authors>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>desc of package</description>
<releaseNotes>release notes text</releaseNotes>
<copyright>Copyright info</copyright>
<tags>some tages</tags>
<dependencies>
<dependency id="Encryption" version="1.1.0" />
...
<dependency id="TeraData" version="16.20.8" />
</dependencies>
</metadata>
<files>
<file src="bin\Release\ProjectTitle.dll" target="lib\net462" />
.....
</files>
</package>
Then, use nuget pack xxx.nuspec -Properties Configuration=Release command to pack it. You should pack the the main project' dll in this way. And if your project refences other assembly dlls or extra exe files.
You should add them:
<file src="bin\Release\extra_assembly.dll" target="lib\net462" />
<file src="bin\Release\extra_exe.exe" target="lib\net462" />
=========================================
However, this function is not very convenient. And we usually do not need them, we usually use this:
nuget pack xxx.csproj
Usually, we use nuget pack xxx.csproj -Properties Configuration=Release to pack without any other node. Before this, you should cd xxx\<project folder>.
use this nuspec file:
<?xml version="1.0" encoding="utf-8"?>
<package >
<metadata>
<id>ProjectTitle</id>
<version>1.0.0</version>
<title>ProjectTitle</title>
<authors>auther name</authors>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>desc of package</description>
<releaseNotes>release notes text</releaseNotes>
<copyright>Copyright info</copyright>
<tags>some tages</tags>
<dependencies>
<dependency id="Encryption" version="1.1.0" />
...
<dependency id="TeraData" version="16.20.8" />
</dependencies>
</metadata>
<!--If you have any other referenced assembly dll files or pdb files, exe files, you should add them here.-->
<files>
.....
</files>
</package>
You should not add your main nuget project's dll with <file> node and it will add into your nupkg automatically with that command.
When you create the new release version of your nuget package, first uninstall the old one under your project, then delete all cache files under C:\Users\xxx\.nuget\packages. After that, reinstall the new release one in your new project.

Here is the nuspec file structure using .NET framework which finally worked for me:
<?xml version="1.0" encoding="utf-8"?>
<package >
<metadata>
<id>ClasslibProj </id>
<version>1.0.0.0</version>
<title> ClasslibProj</title>
<authors>author(s) name</authors>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>desc</description>
<releaseNotes>release notes</releaseNotes>
<copyright>Copyright # Company name 2021</copyright>
<tags>tags to search </tags>
<references>
<group targetFramework=".NETFramework4.6.2">
<reference file="SomeOtherNugetpackage1.dll"/>
<reference file="anyexecutable.exe"/>
…
<reference file="ClasslibProj.dll"/> //dll you are working with
</group>
</references>
</metadata>
<files>
<file src="bin\Release\SomeNugetOtherpackage1.dll" target="lib\net20"/>
<file src="bin\Release\anyexecutable.exe" target="lib"/>
..
<file src="bin\Release\ClasslibProj.dll" target="lib\net462"/>
</files>
</package>
Build project in Release mode.
use command:
nuget pack ClasslibProj.csproj
As mentioned by Sara Liu, avoid using ClasslibProj.nuspec
or you may use detailed command:
nuget pack ClasslibProj.csproj -Properties Configuration=Release

Nuget package creation - Class library that targets .NET framework 4.6.1 can not target correct framework

I created a class library that targets .net framework 4.6.1 (so pretty much a blank canvas, with a single method to return a string, just for testing purposes). I want to make this into a nuget package. I'm following this article https://learn.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package-using-visual-studio-net-framework , but when I get to "nuget pack" I get the following warning:
"WARNING: NU5128: Some target frameworks declared in the dependencies group of the nuspec and the lib/ref folder do not have exact matches in the other location. Consult the list of actions below:
- Add a dependency group for .NETFramework4.6.1 to the nuspec"
I tried adding the dependency group to the .nuspec file:
<?xml version="1.0"?>
<package>
<metadata>
<id>$id$</id>
<version>$version$</version>
<title>$title$</title>
<authors>Author</authors>
<owners>$author$</owners>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>H</description>
<copyright>Copyright 2019</copyright>
<tags>blah</tags>
<dependencies>
<group targetFramework=".NETFramework4.6.1" />
</dependencies>
</metadata>
</package>
and I also tried:
<?xml version="1.0"?>
<package>
<metadata>
<id>$id$</id>
<version>$version$</version>
<title>$title$</title>
<authors>Author</authors>
<owners>$author$</owners>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>H</description>
<copyright>Copyright 2019</copyright>
<tags>blah</tags>
<dependencies>
<group targetFramework="net461" />
</dependencies>
</metadata>
</package>
I still get same error.
I tried using older versions of nuget, where the warning message isn't shown, but the same problem persists (If I try to add via the package manager, it says it has no dependencies).

WARNING: NU5128: Some target frameworks declared in the dependencies
group of the nuspec and the lib/ref folder do not have exact matches
in the other location. Consult the list of actions below.
This is an open issue in Github/Nuget, see #8713. I can reproduce same issue in my VS2017 with Nuget V5.3, and this issue goes away if I use Nuget V5.2 or earlier. For this situation, I'm afraid you have to use earlier versions of Nuget.exe until the team releases the fix.
If I try to add via the package manager, it says it has no
dependencies
1.If it displays no package dependencies though your package project depends on some nuget packages, please check if you're using packageReference to manage nuget in your current project. For now, nuget pack command doesn't work well for .net framework projects with packageReference or new SDK format projects.
You can check details from Leo's answer to resolve this issue.
2.If the no dependencies you mean is that when one project consumes your package, it doesn't display which framework your project targets like this:
(We can see your package depends on Newtonsoft.Json but we can't find which framework it targets(net461).)
For this, we need to use command like nuget pack xx.nuspec to add the dependencies+group into package when packing. Then we can see both targets framework and dependent packages like this:
Hope all above helps and if I misunderstand anything, feel free to correct me :)

Visual Studio Nuget Manager reports "unsupported" for the .NETStandard2.0 section of a custom Nuget

We have a .NetStandard2.0 project which is meant to be packaged into a nuget following the technique explained here:
https://stackoverflow.com/a/45004898/863651
with a nuspec file which looks like so:
<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
<!-- https://stackoverflow.com/a/45004898/863651 we had to resort to employing a seperate nuspec -->
<!-- file because thats the canonical way to include more than one dlls into the resulting nuget -->
<metadata>
<id>$id$</id>
<tags>$tags$</tags>
<owners>$owners$</owners>
<version>$version$</version>
<authors>$authors$</authors>
<description>$description$</description>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<dependencies>
<group targetFramework=".NETFramework4.5">
</group>
<group targetFramework=".NETStandard2.0">
<dependency id="Newtonsoft.Json" version="12.0.1" exclude="Build,Analyzers" />
</group>
</dependencies>
<frameworkAssemblies>
<frameworkAssembly assemblyName="System" targetFramework=".NETFramework4.5" />
<frameworkAssembly assemblyName="Microsoft.CSharp" targetFramework=".NETFramework4.5" />
</frameworkAssemblies>
</metadata>
<files>
<file src="bin\$config$\netstandard2.0\*.dll;bin\$config$\netstandard2.0\*.pdb;" target="lib\netstandard2.0\" />
</files>
</package>
As you can see there is a section targeting .NetStandard2.0. The nuget package is generated by our build server using the following msbuild scriptlet:
<MSBuild Projects="C:\path\to\foo.csproj" Targets="Clean;foo;" Properties="SkipRestoringNugetPackages=true;Configuration=Release;Platform=AnyCPU;" ToolsVersion="15.0" />
The resulting nuget package is getting pushed into a nuget server with the following specs:
NuGet.Server v2.10.3.0
When reviewing the package through Visual Studio 2017 Nuget Package Manager of a .Net4.8 project the following is displayed on the sidebar:
Why does it say "Unsupported" for the .NetStandard2.0 section? Other packages don't display something like that and I can't find see any typos in the xml of the nuspec.

I've just found your issue could be related to the version of Nuget.Server package since you don't use nuget pack command. With same nuget package, when I use Nuget.server 2.10.3, it displays unsupported, After I update the Nuget.server to 3.4.1, all works well now. Let me know if it helps:)
I made a package locally, when I try to consume it in VS all works well.
After I deploy same package to nuget server 2.10.3, it displays unsupported!
So if the issue occurs when you try to fetch the package from the server after you deploy to it. I think it's because the Nuget.Server package you use is too old! Updating the Nuget.Server package can help resolve this issue.

Create nuget package for a solution with multiple projects

We are currently building a solution with several projects.
We have something like this:
- Common
- Logging
- Logging.NLog
- Threading
So Logging.NLog is dependant on Logging, Logging on Common...etc.
When we pack Logging.NLog I would like nuget to discover the Loggin and Common dependecies.
At the moment, I created a package with Common, then in Logging I installed the package Common with
install-package Common
But whenever I do a modification to Common, I have to update the package and they are created by our continous integration systeme (Hudson), so it is pretty annoying when we are developing.
I would like to simply have a Project Reference (Add References -> Project...) and the nuget discover the depencies anyway.
Is there a way to achieve it?

There is a planned feature targeting this exact scenario.
This is how it will apparently look like:
> nuget.exe pack proj.csproj -IncludeReferencedProjects
It has apparently been implemented mere days ago, but there are bugs still being ironed out.
The feature, as it currently stands, allows:
packaging several projects' artifacts into a single nuget package (by walking project references recursively),
OR
creating nuget package references to those projects's associated packages, if the referenced projects have accompanying .nuspec files.
The feature request dates back all the way to 1.5, but it kept slipping. Recently though, it gathered enough mass (requests) to be scheduled for release in Nuget 2.3.
The release plan pegs version 2.3 for "End of April, 2013" so stay tuned.
(Presently, the latest Nuget version is 2.2.1).

There is currently no way to do exactly what you ask, but the following will help you streamline your updates.
It sounds like you need to add nuspec files to your solution. Something like the following three files. Note the dependencies in the second two. These refer to the same dll version as common through [$version$]. This means that when you run the following command, it updates all three because the square brackets on the dependencies require a specific version of the dependent packages.
PM> update-package common
In Hudson, you will need to execute these nuspec files using nuget pack command (see Nuget command reference) and include the resulting packages in your artifacts, AND deploy them to your local nuget server. I will leave that over to you.
The other thing you would need to do is ensure that all of your assemblies get the same version for the same build. Again, Hudson can take care of this or you could use a common AssemblyInfo file.
Common.nuspec
<?xml version="1.0"?>
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
<metadata>
<version>$version$</version>
<authors>Charles Ouellet</authors>
<owners />
<iconUrl>http://domain/Content/images/LOGO_32x32.png</iconUrl>
<id>Common</id>
<title>Common</title>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>full description here</description>
</metadata>
<files>
<file src="..\Common\bin\Release\Common.dll" target="lib\net40" />
<file src="..\Common\bin\Release\Common.pdb" target="lib\net40" />
</files>
</package>
Logging.nuspec
<?xml version="1.0"?>
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
<metadata>
<version>$version$</version>
<authors>Charles Ouellet</authors>
<owners />
<iconUrl>http://domain/Content/images/LOGO_32x32.png</iconUrl>
<id>Logging</id>
<title>Logging</title>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>full description here</description>
<dependencies>
<dependency id="Common" version="[$version$]" />
</dependencies>
</metadata>
<files>
<file src="..\Logging\bin\Release\Logging.dll" target="lib\net40" />
<file src="..\Logging\bin\Release\Logging.pdb" target="lib\net40" />
</files>
</package>
Logging.NLog
<?xml version="1.0"?>
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
<metadata>
<version>$version$</version>
<authors>Charles Ouellet</authors>
<owners />
<iconUrl>http://domain/Content/images/LOGO_32x32.png</iconUrl>
<id>Logging.NLog</id>
<title>Logging.NLog</title>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<description>full description here</description>
<dependencies>
<dependency id="Logging" version="[$version$]" />
</dependencies>
</metadata>
<files>
<file src="..\Logging.NLog\bin\Release\Logging.NLog.dll" target="lib\net40" />
<file src="..\Logging.NLog\bin\Release\Logging.NLog.pdb" target="lib\net40" />
</files>
</package>

I think Charles means he wants NuGet to automatically resolve project references into package dependencies if said referenced projects also are used to construct NuGet packages, right?
Example:
Logging is set up to generate a NuGet package
Logging.Nlog is set up to generate a NuGet package
Logging.Nlog has a project reference to Logging.
The generated Logging.Nlog package should get a dependency on the generated Logging package.
This is something I had been looking for myself as well, but sadly I found that it is currently not supported. There is a work item on it, scheduled for NuGet 1.7, but there isn't even a design on how to handle this yet.

This thread has a good suggestion: NuGet and multiple solutions
Basically, break out the common components to their own Solution, with their own release lifecycle.

I managed this achieve it like this:
<ProjectReference Include="MyProject2.csproj" PrivateAssets="All" />
Add PrivateAssets="All" in MyProject.csproj for each project.