Skip to content
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.

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

Switch to embedded PackageIcon #1286

Closed
wants to merge 2 commits into from
Closed

Switch to embedded PackageIcon #1286

wants to merge 2 commits into from

Conversation

wtgodbe
Copy link
Member

@wtgodbe wtgodbe commented Sep 23, 2019

Part of https://github.com/aspnet/AspNetCore-Internal/issues/3146

Local build passes the smell test with these changes. I'm still unsure on whether or not we need to include a reference to the package icon in the .nuspec - the "old way" did so automatically, the "new way" does not (https://docs.microsoft.com/en-us/nuget/reference/msbuild-targets#packing-an-icon-image-file). CC @tmat who may know more about that question.

@wtgodbe wtgodbe requested a review from a team September 23, 2019 21:49
@tmat
Copy link
Member

tmat commented Sep 23, 2019

@nkolev92

@nkolev92
Copy link

nkolev92 commented Sep 23, 2019

That's really up to you at this point.

NuGet.org will eventually transition to a world where it only accepts packages with a self contained icon, but other feeds may not implement this soon if ever.

//cc @karann-msft @dominoFire

@dougbu
Copy link
Member

dougbu commented Sep 23, 2019

only accepts packages with a self contained icon,

I'm not sure this answers the question we had. For NuGet.org, should the .nuspec reference the icon file?

@nkolev92
Copy link

The newly icon metadata has to be used for NuGet.org.

@wtgodbe
Copy link
Member Author

wtgodbe commented Sep 23, 2019

The newly icon metadata has to be used for NuGet.org.

@nkolev92 what do you mean by this? I followed the example from https://docs.microsoft.com/en-us/nuget/reference/msbuild-targets#packing-an-icon-image-file in this PR, which resulted in an icon file in the root of the .nupkg, but no reference to it in the .nuspec. Is that sufficient?

@nkolev92
Copy link

The adding of the propery should burn it into the nuspec.

    <PackageIcon>icon.png</PackageIcon>

If that's not the case, make sure a high enough version of the SDK is being sued.
I think this was added in 3.0.0-preview8

@tmat
Copy link
Member

tmat commented Sep 23, 2019

@nkolev92 That's assuming the nuspec is auto-generated, correct? It seems like a couple of projects in this repo have hand written nuspecs. @wtgodbe Perhaps it would be good time to migrate to auto-generated nuspecs?

@wtgodbe
Copy link
Member Author

wtgodbe commented Sep 24, 2019

Ah, looks like you're correct. I made this change in several repos, all of which auto-generate nuspec's by default, except for a few exceptions (such as the manual ones in this PR). The ones which were auto-generated do have the icon metadata in their nuspec. I'll add an icon element to the manual .nuspec's, then open an issue to migrate all .nuspec's to be auto-generated.

Copy link
Member

@dougbu dougbu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wtgodbe please let me know when the missing property is in the .nuspec files and you've confirmed the final packages

@wtgodbe
Copy link
Member Author

wtgodbe commented Sep 24, 2019

With the last change, this now includes the icon metadata in all .nuspec's, including the manually generated ones - @dougbu PTAL

Copy link
Member

@dougbu dougbu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good but should target 'release/6,.3'

@wtgodbe
Copy link
Member Author

wtgodbe commented Sep 24, 2019

Closing in favor of #1291

@wtgodbe wtgodbe closed this Sep 24, 2019
@wtgodbe wtgodbe deleted the Embedded branch January 5, 2021 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants