feat(.net): embed package icon when configured #3676
Conversation
When an `iconUrl` is configured for a .NET target, attempt to download it for inclusion in the NuGet package with the `PackageIcon` attribute, as the `PackageIconUrl` attribute is deprecated. This feature can be opted out of by setting the `JSII_PACMAK_DOTNET_NO_DOWNLOAD_ICON` environment variable (no matter what value it has). If the download somehow fails, the previous behavior is preserved. The `PackageIconUrl` attribute is still emitted for backwards compatibility with tools that do not (yet) support `PackageIcon`.
| } | ||
| break; | ||
| default: | ||
| // Nothing to do... |
There was a problem hiding this comment.
if it's not one of these, how can it be a valid icon? Shouldn't this be an error?
There was a problem hiding this comment.
The spec unfortunately does not specify what is a valid MIME type for the icon, and there are more image formats that I can't be bothered with (ico, heic, etc..)
| // Attempt to download the package icon from the configured URL so we can use the non-deprecated PackageIcon | ||
| // attribute. If this fails or is opted out (via $JSII_PACMAK_DOTNET_NO_DOWNLOAD_ICON being set), then only the | ||
| // deprecated PackageIconUrl will be emitted. | ||
| const iconFile = |
There was a problem hiding this comment.
Is there a way for the user to pass this file without downloading it (eg if they already have the icon locally)?
There was a problem hiding this comment.
Not currently... That'd require they bundle the icon in their npm package, which I'm not sure is appropriate...
|
Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it! |
|
Merging (with squash)... |
1 similar comment
|
Merging (with squash)... |
…e-icon # Conflicts: # packages/jsii-calc/test/assembly.jsii
|
Merging (with squash)... |
Introduced in aws/jsii#3676 and released in `jsii@1.64.0`
When an
iconUrlis configured for a .NET target, attempt to downloadit for inclusion in the NuGet package with the
PackageIconattribute,as the
PackageIconUrlattribute is deprecated.This feature can be opted out of by setting the
JSII_PACMAK_DOTNET_NO_DOWNLOAD_ICONenvironment variable (no matterwhat value it has).
If the download somehow fails, the previous behavior is preserved.
The
PackageIconUrlattribute is still emitted for backwardscompatibility with tools that do not (yet) support
PackageIcon.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.