Self-contained NuGet Packages - Icons should be embedded in Packages #352
Comments
|
Note: Transferred from issue on CodePlex - Packages containing Icon and License Packages containing Icon and LicenseProblem StatementCurrently, the NuGet schema only allows the package author to specify the LicenseUrl and IconUrl as external URLs for the license and icon respectively. This puts the burden on the developer to find a place to host those files and update the NuSpec with their locations. SolutionThe NuGet Gallery should support unpacking a license and icon within the package folder both explicitly specified and by convention. DetailsConvention Based ApproachThe convention based approach is very simple.
Explicit ReferenceAlternatively, we can support explicit references using the file:// prefixed URLs relative to the package root. For example:
This grabs the file from the content/images folder of the package and hosts it on the server. This is useful in cases where the icon is also hosted. Device Specific Icon ImagesThere a multiple places where icons are displayed.
We should consider a convention that allows developers to include an icon specific to each of these devices. ProposalUse a file extension for each.
|
|
We see some customers unable to view icons as the web location of the icon image is blocked by their corporate firewall. Possible solution could be to download and serve the images from NuGet.org as a resource at the same URI as the package when an image media type is requested |
xavierdecoster
changed the title
|
To support an embedded package icon in the nupkg, it seems we only need the 32x32 icon. All other images are only served on the gallery and don't need to be in the package. As this issue is about supporting an embedded icon in the package, it sounds to me that a convention-based icon.png in the package root could be sufficient? |
|
That's an entirely different discussion. All we need is package icon proxying over www.nuget.org. |
|
Nope, your discussion is here: NuGet/NuGetGallery#2613 |
yishaigalatzer
added
Type:Feature
Priority:3
We should specify the size in the icon name instead icon32x32.png We need to discuss if we require all of them, can they be updated later etc. |
|
I'd prefer to see the scale convention used by win8 manifests used here too. this would mean that brand images can be re-used and we don't need to create even more files named differently. |
I think that just requiring the biggest required size is enough. That image can be downsized to all the other necessary resolutions. |
|
|
Downsizing is suboptimal. There is no escape from separate files if you want decent quality. Even the official purple ".NET" icon doesn't look that great in its downsized 32x32 form. Having the option to only provide one size and have the rest downsized is great, as long as there's a way to provide files for the different sizes separately. |
|
The image in package details on nuget.org is 128x128, not 100x100.
Although, in order to have that showing with full fidelity on a high DPI display, you need a larger image. E.g. I run my display scaled at 200%. Notice the difference between a 128x128 image and a 256x256 image, even though the dimensions within the page are still 128x128:
For this reason, I am gradually changing all my NuGet packages to have 256x256 logos instead of 128x128. Of course, that only solves this precisely for high DPI scaling at 200%, and any other level of scaling, e.g. 125%, 150% or greater than 200% will still be suboptimal. One thing that would solve all these issues, forever, is SVG support, since that eliminates the need for image scaling entirely. BTW - the dimensions in the package list are 48x48, not 50x50:
|
|
+1 for svg as the default |
|
hi, electron-windows-installer:spawn Spawning mono /var/www/html/Extraction/node_modules/electron-winstaller/vendor/nuget.exe pack /tmp/si-11702-14710-a00hji.hot6ueg66r/app.nuspec -BasePath dist/app-win32-ia32 -OutputDirectory /tmp/si-11702-14710-a00hji.hot6ueg66r -NoDefaultExcludes +3ms Unhandled Exception: System.TypeLoadException: Could not load type 'NuGet.Program' from assembly 'NuGet, Version=2.8.50926.602, Culture=neutral, PublicKeyToken=null'. |
|
Is it possible to refer to an image in a directory outside the project? It would be very useful to do so if you have multiple NuGet packages in a solution: <PropertyGroup Label="Package">
<!-- This is what I've tried: -->
<PackageIcon>file://../../Images/Icon.png</PackageIcon>
<PackageIcon>../../Images/Icon.png</PackageIcon>
</PropertyGroup>
<ItemGroup Label="Files">
<None Include="..\..\Images\Icon.png" Pack="true" PackagePath=""/>
</ItemGroup>However, all I've tried so far produces errors. UPDATE I've figured it out. This seems to work: <PropertyGroup Label="Package">
<PackageIcon>Icon.png</PackageIcon>
</PropertyGroup> |
|
I think this was supported. @karann-msft would know better. And I saw the UPDATE after I typed 😁 |
|
Glad you found the right way. The package path put the image in the root of the package. Please take a look at the docs and suggest any improvements that would help with this case. |
anangaur
changed the title
|
After seeing this, I really wanted to package an icon in my My <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<package>
<metadata>
<id>NExpect</id>
<version>1.0.158</version>
<title>NExpect</title>
<authors>Davyd McColl</authors>
<owners>Davyd McColl</owners>
<description>



Unit-test Framework-agnostic Expect-style assertions for .NET



</description>
<releaseNotes>



</releaseNotes>
<summary>



Provides Expect() syntax for doing assertions in .NET. Framework-agnostic, throwing



UnmetExpectationExceptions for failures. Assertion exception type can be overridden at run-time.



NExpect has grammar inspired by Chai and extensibility inspired by Jasmine.



</summary>
<language>en-US</language>
<projectUrl>https://github.com/fluffynuts/NExpect</projectUrl>
<icon>icon.png</icon>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<license type="expression">BSD-3-Clause</license>
<copyright>Copyright 2017</copyright>
<dependencies>
<group targetFramework="net452"/>
</dependencies>
<references/>
<tags/>
</metadata>
<files>
<file src="icon.png" target="" />
<file src="bin\BuildForRelease\net452\NExpect.dll" target="lib\net452"/>
<file src="bin\BuildForRelease\net452\NExpect.pdb" target="lib\net452"/>
<file src="bin\BuildForRelease\netstandard2.0\NExpect.xml" target="lib\net452"/>
<file src="bin\BuildForRelease\netstandard2.0\NExpect.dll" target="lib\netstandard2.0"/>
<file src="bin\BuildForRelease\netstandard2.0\NExpect.xml" target="lib\netstandard2.0"/>
<file src="bin\BuildForRelease\netstandard2.0\NExpect.pdb" target="lib\netstandard2.0"/>
<file src="bin\BuildForRelease\netstandard2.0\NExpect.deps.json" target="lib\netstandard2.0"/>
</files>
</package>what am I doing wrong? |
|
@fluffynuts you need NuGet.exe version 5.3, guess it's not blessed yet, as it's not available on nuget ( https://www.nuget.org/packages/NuGet.CommandLine/ ). But you can download it from https://www.nuget.org/downloads |
|
Ah, thanks -- I did a |
|
Looks like our blessing we did of 5.3 missed a step. We’ll fix on Monday. |
|
@fluffynuts are you unable to use |
|
@rrelyea - can you also please publish working nuspec.xsd's? It would be nice to get some schema based intellisense in VS for nuspec files. |
|
@adamralph whilst I'm in the process of converting to modern projects (
This hasn't stopped my release -- I just reference the icon by url from GitHub. I was just wanting to use the new mechanism seeing as I was in the neighborhood -- I just got an icon from an #hacktoberfest PR 👍 |
|
@SimonCropp's comment has 17 upvotes (only 👍 counts). GitHub doesn't have any way for us to transfer upvotes from one issue to another (let alone a comment from an issue). So, anyone interested please upvote this issue on adding SVG support (original/first comment, not my comment). At this time, that issue only has 3 upvotes (probably because it was closed years ago, but I just reopened it). |
|
@zivkan - Can you make a feature request through official channels for that kind of thing? I would think it would be something you would have a better time requesting than the GenPop. If not or you dont want to wait, I imagine scripting something would be the way to aggregate votes across comments and issues for the same request.
Lets not have any digital gerrymandering or "chads"; 👍 ❤️ 😆 🚀 and :Hooray: are all positive reactions and should all be counted as upvotes. Excluding them would be removing > 30% of the current votes. |
|
Microsoft may have bought GitHub, but they still operate as an external company, and I have no inside knowledge or contacts. I don't even know where external customers can request new features.
GitHub doesn't provide a way to sort issues by "all positive reactions", at least that I'm aware of. Therefore, while we prioritize work on a number of factors, on GitHub I look at open issues sorted by 👍 , as that appears to be the most commonly used reaction. While it would be nice to count all positive reactions, we need to be pragmatic and it's something we can't easily take into account right now. If I'm wrong, I'd be happy for someone to educate me so we can better take all reactions into account. |
For that specific comment... $ErrorActionPreference = 'Stop'
$headers = @{"Accept"="application/vnd.github.squirrel-girl-preview+json";}
$url = "https://api.github.com/repos/NuGet/home/issues/comments/261106692/reactions"
$resp = Invoke-WebRequest -Headers $headers -Uri $url -UseBasicParsing
$rawResp = $resp.Content | ConvertFrom-Json
$rawResp | Group-Object -Property content | Sort-Object -Descending -Property Count | Format-Table -Property Count,Name
#####results####
Count Name
----- ----
17 +1
5 heart
2 hooray
1 laugh I opened a ticket with GH support on how to do this through the UI, they said its currently not possible via the UI but forwarded the request to the product team with a link to the comment above by @zivkan explaining the need. |
|
Is a side effect of this change that the Nuget package download now includes the icon file? We released a new version of our package using the new and tag in the nuspec and now our client downloads have our logo.png showing up in their projects. If that is correct, is there a way to override this? A typical user for us wouldn't care if the nuget package manager properly shows the icon, but it's annoying for them to have our logo force its way into their project file structure. I would still want our package to have a logo on the Nuget Package Manager online search. |
|
@rudyscoggins my which I assume is the secret sauce for not having the icon deployed to the consumer (ie |
|
The icon will only appear in consuming projects if the package has been incorrectly created. |
|
Ah, so I am doing something wrong. I'm not sure what though. I have the target=""... Here's my nuspec file. Could you take a quick glance to see if something is wrong? The image lives at my project file root: |
|
Are you creating your package with an explicit nuspec? If possible, I advise moving away from that and allowing the SDK to create the nuspec for you. FWIW, I just have a If I dig into the <?xml version="1.0" encoding="utf-8" standalone="yes"?>
<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
<metadata>
<id>Bullseye</id>
<version>3.7.0</version>
<authors>Bullseye</authors>
<owners>Bullseye</owners>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<license type="expression">Apache-2.0</license>
<licenseUrl>https://licenses.nuget.org/Apache-2.0</licenseUrl>
<projectUrl>https://github.com/adamralph/bullseye</projectUrl>
<description>Runs a target dependency graph.</description>
<releaseNotes>https://github.com/adamralph/bullseye/blob/master/CHANGELOG.md</releaseNotes>
<repository type="git" url="https://github.com/adamralph/bullseye" commit="89fc1b57063c44e21bc851f218f166ca63a6e846" />
<dependencies>
<group targetFramework=".NETStandard2.0" />
</dependencies>
<icon>bullseye.png</icon>
</metadata>
</package>Note that there is no |
|
Oh, there is also this — https://github.com/adamralph/bullseye/blob/d11fea517642b5f56f19d5a6963f4a818b698cc9/Bullseye/Bullseye.csproj#L26 — so I guess it's not quite as simple as it could be. |
|
Thanks all for the help and sanity checks! I really appreciate it and it helped me solve the problem. Turns out I thought I needed to include the image file in the project. After experimenting, I realized it SHOULDN'T be included in the project and is only meant to reside in the nuget package. This is what caused it to be distributed. Hopefully this helps someone else. @adamralph my upload process needs to be revised, relying more on self made scripts than nuget standards. I'll incorporate your suggestion for moving more into the SDK. Thanks! |
I don't get it. What kind of burden is this? If you want to update an icon you would update it one place... Now I actually do need to specify the icon anyway and copy the icon to every project which suppose to be packed and make sure the icon have the same version in all those places... Is this a less burden? What kind of improvement is this? |
because that would be a breaking change. ie for anyone expecting the old behavior of being able to change the icon at the target url and have the package be rendered with the new icon |
and others
Package Icon should be able to come form inside the package.
It should be possible to put a path in the iconUrl that is relative to the package.
The text was updated successfully, but these errors were encountered: